API Reference

Create a payment batch

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

📘 NOTE: This should be used when many payments will be associated with the payment batch. Once all payments have been associated, call "initiate" to initiate the payment batch.

Body Params

The entity containing the payment batch data

string | null

Gets or sets the id that can be used to correlate multiple batches into a single "group" of batches.

string
required
length between 1 and 50

Gets or sets the issuer batch identifier.

string
required
length ≥ 1

Gets or sets the account short code.

string
required
length ≥ 1

Gets or sets the sub-account short code.

double
required
0 to 9999999999.99

Gets or sets the total amount.

int64
required
1 to 2147483647

Gets or sets the total number of payments for the payment batch.

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
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