curl --request POST \
--url https://api.next.orenda.finance/v1/customers/{customerId}/batch-payments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"action": "verify",
"payments": [
{
"payer": {
"account": {
"type": "uk",
"sortCode": "010203",
"accountNumber": "12345678"
}
},
"payee": {
"name": "Ada Lovelace",
"account": {
"type": "uk",
"sortCode": "040506",
"accountNumber": "87654321"
},
"accountType": "CONSUMER"
},
"reference": "Invoice 1024",
"amount": "150.00"
},
{
"payer": {
"account": {
"type": "iban",
"iban": "DE89370400440532013000"
}
},
"payee": {
"name": "Grace Hopper",
"account": {
"type": "iban",
"iban": "FR7630006000011234567890189",
"bic": "AGRIFRPP"
}
},
"reference": "Invoice 1025",
"amount": "200.00"
}
]
}
'{
"success": true,
"requestId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"status": "PENDING"
}Batch action (verify / initiate / submit)
A single endpoint that drives the whole batch flow; the action field selects the step.
verify— submit the items for validation and name-checking (COP for UK, VOP for EU). Returns arequestId; poll verify status until it completes.initiate— get thetotalAmount,currency, and anscaChallengefor the verified set.passkey-challenge— get a passkey challenge to satisfy SCA with a passkey.submit— send the batch with SCA: aconfirmationobject withmethod: "passkey","totp", or"pin". Returns thebatchId.
Use the examples dropdown below to see each action’s request and response.
Drafts. This route serves every action, so it also participates in the draft flow: verify creates a draft and returns its batchId and expiresAt, and submit accepts a batchId to pay one. Behaviour is identical to the split /verify and /submit routes — only the URL and the permission differ.
curl --request POST \
--url https://api.next.orenda.finance/v1/customers/{customerId}/batch-payments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"action": "verify",
"payments": [
{
"payer": {
"account": {
"type": "uk",
"sortCode": "010203",
"accountNumber": "12345678"
}
},
"payee": {
"name": "Ada Lovelace",
"account": {
"type": "uk",
"sortCode": "040506",
"accountNumber": "87654321"
},
"accountType": "CONSUMER"
},
"reference": "Invoice 1024",
"amount": "150.00"
},
{
"payer": {
"account": {
"type": "iban",
"iban": "DE89370400440532013000"
}
},
"payee": {
"name": "Grace Hopper",
"account": {
"type": "iban",
"iban": "FR7630006000011234567890189",
"bic": "AGRIFRPP"
}
},
"reference": "Invoice 1025",
"amount": "200.00"
}
]
}
'{
"success": true,
"requestId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"status": "PENDING"
}Authorizations
The caller's id_token from authentication — the ID token, not the access_token. The program and environment come from the token.
Path Parameters
The customer id.
Body
The step to run.
verify, initiate, passkey-challenge, submit The payment items. Required for verify, initiate, and submit.
Show child attributes
Show child attributes
The strong-customer-authentication challenge from initiate. Pass it back on submit.
Show child attributes
Show child attributes
Step-up confirmation (for submit). Set method to passkey, totp, or pin and include that method's fields. pin is a program capability — see Program capabilities.
- Passkey
- 2FA code
- PIN
Show child attributes
Show child attributes
Optional. Reuse the same key to make submit safe to retry.
Optional. On verify, the draft being re-verified after edits — omit to create a new draft. On submit, the draft to pay; it is checked for expiry and ownership and cannot be paid twice. Absent keeps the pre-draft behaviour.
Response
Result for the requested action
The response is of type object.