API Reference

Modify a batch

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

Modify details of a created or held batch of payments

Path Params
string
required

The ID of the batch to modify

Body Params

The entity containing the data about the batch to modify.

string | null

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

double
required
0 to 9999999999.99

Gets or sets the total amount.

int64
required
1 to 2147483647

Gets or sets the number of payments.

string
required
length ≥ 1

Who the batch is being modified by

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses
204

If the batch is modified

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