List batches
curl --request GET \
--url https://api.next.orenda.finance/v1/batch-payments \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
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"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"success": true,
"data": {
"paymentsBatches": [
{
"id": "batch-123",
"customerId": "customer-123",
"custodianId": "custodian-123",
"programId": "program-123",
"sandbox": false,
"paymentsCount": 3,
"createdDateTime": "2026-06-16T10:00:00.000Z",
"customerName": "Jane Doe",
"custodianName": "Org Ltd",
"itemsStatus": {
"completed": 1,
"pending": 1,
"processing": 1,
"failed": 0
},
"totalAmount": "1250.50"
}
],
"nextToken": "eyJpZCI6ImJhdGNoLTEyMyJ9"
}
}{
"success": false,
"code": "VALIDATION_ERROR",
"message": "payee.sortCode must be 6 digits"
}{
"success": false,
"code": "UNAUTHORIZED",
"message": "Unauthorized"
}Batch payments
List batches
Lists batch payments accessible to the authenticated caller, most recent first. The response is paginated and each returned batch is enriched with customer/custodian names, item status counts, and total batch item amount. Customer callers can be resolved from the authorizer context.
GET
/
v1
/
batch-payments
List batches
curl --request GET \
--url https://api.next.orenda.finance/v1/batch-payments \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
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"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"success": true,
"data": {
"paymentsBatches": [
{
"id": "batch-123",
"customerId": "customer-123",
"custodianId": "custodian-123",
"programId": "program-123",
"sandbox": false,
"paymentsCount": 3,
"createdDateTime": "2026-06-16T10:00:00.000Z",
"customerName": "Jane Doe",
"custodianName": "Org Ltd",
"itemsStatus": {
"completed": 1,
"pending": 1,
"processing": 1,
"failed": 0
},
"totalAmount": "1250.50"
}
],
"nextToken": "eyJpZCI6ImJhdGNoLTEyMyJ9"
}
}{
"success": false,
"code": "VALIDATION_ERROR",
"message": "payee.sortCode must be 6 digits"
}{
"success": false,
"code": "UNAUTHORIZED",
"message": "Unauthorized"
}Authorizations
The user's access_token. The program and environment come from the token.
Query Parameters
Maximum number of batches to return. Values above 1000 are clamped to 1000. Invalid values include 0, negative numbers, non-integer strings, and mixed strings such as 10abc.
Required range:
x >= 1Pagination token returned by a previous response.
Lookback window for program-admin searches. Invalid values include 0, negative numbers, non-integer strings, and mixed strings such as 10abc.
Required range:
x >= 1⌘I