Submit Batch

post

https://api-sandbox.paymentlabs.io/batches/{batchId}/submit

Sends every eligible payment in a batch. The request is accepted and the payments are selected and sent in the background.

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.

Which payments are sent. Payments that are DRAFT, FAILED or RETURNED, not being cancelled, and whose payee is
payable. With autoSubmit: true, payments whose payee cannot be paid yet are included too; they wait in
WAITING_PAYABILITY and are sent when the payee finishes onboarding. Every other payment is skipped without an error. The
options in the body apply to every payment sent.

What 202 means. Only that the batch was accepted. There is no balance check before the response: a payment that your
ledger account cannot cover stays SUBMITTED until the account is funded. Check the result with Search Payments filtered on
batchId, or follow the payment-status-changed webhook (/reference/payment-status-changed). See Submit Payment for the
statuses a sent payment goes through.

Retries. Retrying is safe: a payment picked up by two requests is sent only once.

Errors

403 FORBIDDEN_CONDITION_NOT_MET: your role has an approval limit.
403 FORBIDDEN_MISSING_GROUP: your account is blocked from sending payments. Contact support.
404 NOT_FOUND: the batch does not exist.
409 CUSTOMER_FROZEN: payouts from your account are frozen. Contact support.
423 NOT_EDITABLE: the batch is archived.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

batchId

string

required

ID of the batch, as returned by Create Batch.

Body Params

Options that control how a payment is sent. The same options apply to every submit operation.

feeCap

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.

fxDifferenceCoverage

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:

autoSubmit

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

Responses

202

The batch was accepted. Its eligible payments are sent in the background.

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

404The resource does not exist in your account.

409Payouts from your account are frozen.

422The request body is not valid JSON, or is not a JSON object. Send Content-Type: application/json with a JSON object body.

423The resource is in a state that does not allow this change, for example a payment that has already been submitted or a batch that has been archived. Read the resource again to see its current state.