curl --request POST \
--url https://api.next.orenda.finance/v1/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"
}
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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'
}
]
})
};
fetch('https://api.next.orenda.finance/v1/batch-payments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.next.orenda.finance/v1/batch-payments"
payload = {
"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"
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"success": true,
"requestId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"status": "PENDING"
}Multi-customer batch payments
Back-office batch action with no customerId in the path — pay from the accounts of any customers the caller is responsible for in a single batch.
Back-office only. The caller must have a back-office role that resolves to one or more customers; a back-office role without any is rejected with 401. Each item’s payer account is resolved globally and authorized per item against the caller: an account the caller is not responsible for — including an unassigned account — is rejected with 401. A non-back-office caller cannot use this route.
The action field selects the step (verify, initiate, passkey-challenge, submit), exactly as on the single-customer POST /v1/customers/{customerId}/batch-payments route.
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/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"
}
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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'
}
]
})
};
fetch('https://api.next.orenda.finance/v1/batch-payments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.next.orenda.finance/v1/batch-payments"
payload = {
"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"
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"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.
Body
The step to run.
verify, initiate, passkey-challenge, submit The payment items. Required for verify, initiate, and submit. Payers may belong to different customers the caller is responsible for.
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
Action result. The body shape matches the action and is identical to the single-customer route (verify → requestId/status; initiate → totalAmount/currency/scaChallenge; submit → batchId/status/counts).
The response is of type object.