POST /v1/customers/{customerId}/batch-payments, where an action field selects
the step. You verify the items, initiate to get a total and an authentication challenge,
then submit with strong customer authentication.
Batch payments are an optional capability, enabled per program. If your program doesn’t
have it, the endpoint isn’t available to you. See Program
capabilities. Every call uses the user’s bearer token.
The items
Each item is one payment. Send the destination fields your program uses:- UK programs use
accountNumber+sortCode. - EU programs use
iban+bic.
scheduledDate (YYYY/MM/DD) to send
an item on a future date.
The flow
- Verify — submit the items. We validate each one and run a
name check on the payee (Confirmation of Payee for UK, Verification of Payee for EU). You
get a
requestId. - Check status — poll until validation finishes. The result marks each item valid or invalid, with errors.
- Initiate — get the
totalAmount,currency, and anscaChallengefor the set you’re sending. - Submit — send the batch with the challenge plus a
confirmationobject (passkey, 2FA code, or PIN on supported programs). You get abatchId. - Track — fetch the batch to watch each item move through
QUEUED→SUCCESSorFAILED.
Status
A batch reports an overallstatus: CREATED, FUNDING_PENDING, FUNDED, PROCESSING,
QUEUED, and the failure states FUNDING_FAILED and PARTIALLY_FAILED. Individual items
are QUEUED, SUCCESS, or FAILED.