API Reference

Associate payments with a payment batch

post
https://api.payments.optum.com/v1/payments/batch//add

After a batch is successfully created this endpoint will allow you to group multiple individual payments under the batch.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The ID of the payment batch to associate the payments to

Body Params

The payments to associate with the payment batch

payments
array of objects
required
length ≥ 1

The payments to be added to the batch.

payments*
paymentDetails
object | null

Information about the payment.

payeeDetails
object | null

Information about the payee

shippingDetails
object | null

Shipping details. Can be used to override information from the payee details

int32
required
0 to 2147483647

The total number of claims in the payment.

claimLevelInformation
array of objects | null

Information about the claims.

claimLevelInformation
providerLevelAdjustment
array of objects | null

The purpose of the Provider Level Adjustment segment is to convey provider level adjustment information for debit or credit transactions such as accelerated payments, cost report settlements for a fiscal year, and timeliness report penalties unrelated to a specific claim or service.

providerLevelAdjustment
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Unauthorized

403

Forbidden

Updated about 1 year ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json

Updated about 1 year ago