Turn On Auto Submit

post

https://api-sandbox.paymentlabs.io/batches/{batchId}/payments/{paymentId}/autoSubmit

Turns on auto-submit for one payment: it is sent now if the payee can be paid, or as soon as they can.

Use it for the "pay when ready" action. It is Submit Payment with autoSubmit: true, and takes the same feeCap and
fxDifferenceCoverage. Undo it with Remove Auto Submit while the payment is WAITING_PAYABILITY.

Requires the Payment Approval permission. If your role has an approval limit, the payment amount must be within it.

What happens. The payment must be DRAFT, FAILED or RETURNED and not already being sent or cancelled.

Payee payable: the payment is sent now, with the same balance check as Submit Payment.
Payee not payable: the payment moves to WAITING_PAYABILITY and is sent when the payee finishes onboarding.

Errors

403 FORBIDDEN_CONDITION_NOT_MET: the payment amount is above your role's approval limit.
403 FORBIDDEN_MISSING_GROUP: your account is blocked from sending payments. Contact support.
404 NOT_FOUND: the batch or the payment does not exist.
409 (no code): the payment is not DRAFT, FAILED or RETURNED, or is already being sent or cancelled.
409 CUSTOMER_FROZEN: payouts from your account are frozen. Contact support.
423 INSUFFICIENT_BALANCE: the payee is payable but the ledger account balance is lower than the payment amount.
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.

paymentId

string

required

ID of the payment, as returned by Create Payment.

Body Params

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:

Responses

202

Auto-submit is on. The payment is being sent, or waits in WAITING_PAYABILITY.

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.

409The payment cannot be sent now. code is CUSTOMER_FROZEN when payouts 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.

423INSUFFICIENT_BALANCE (fund your ledger account) or NOT_EDITABLE (the batch is archived).