Submit Payments

Sends up to 50 payments, from one or several batches, in one request, and reports the outcome of each.

Use it to pay a selection of payments. To send every eligible payment in one batch, use Submit Batch.

Requires the Payment Approval permission without an approval limit. A role with an approval limit gets
403 FORBIDDEN_CONDITION_NOT_MET; submit each payment with Submit Payment instead.

Each payment follows the rules of Submit Payment, including the balance check, and the options in the body apply to all of
them. The response is 200 even when some or all payments are refused: read success and errorCode for each one. Accepted
payments are sent in the background, as with Submit Payment. Retrying the request is safe; a payment already being sent comes
back with PAYMENT_NOT_SUBMITTABLE.

Errors

  • 400 VALIDATION_ERROR with details.payments[0].code = TOO_MANY_PAYMENTS: send 50 payments or fewer.
  • 403 FORBIDDEN_CONDITION_NOT_MET: your role has an approval limit.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Body of Submit Payments.

string

The most you pay in transaction fees for each payment, as a decimal string in the payment's currency ("2.50"). Fees above the
cap are deducted from what the payee receives. Omit it to use the fee cap configured for the payout method or for your account.

string
enum

Who covers the difference when a RETURNED payment is sent again and the amount that came back is lower than the original
amount (because of exchange rates or return fees). payor: the payee receives the original amount again and you fund the
difference. payee: the amount that came back is sent. Ignored for payments that were never returned. Omit it to use your
account's setting for the payment category.

Allowed:
boolean
Defaults to false

Send the payment as soon as the payee can be paid. With true, a payment whose payee cannot be paid yet moves to
WAITING_PAYABILITY and is sent automatically, with these same options, when the payee finishes onboarding. With false,
such a payment is refused (or skipped, on batch submit).

payments
array of objects
required

Payments to send, from one or several batches. Send 1 to 50 items; an empty list returns an empty results. Always send this field.

payments*
Responses

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