curl --request GET \
--url https://api.next.orenda.finance/v1/batch-payments/{batchId} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.next.orenda.finance/v1/batch-payments/{batchId}', 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/{batchId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"success": true,
"data": {
"paymentsBatchItems": [
{
"id": "a1b2c3d4-1111-2222-3333-444455556666",
"batchId": "b2c3d4e5-0000-1111-2222-333344445555",
"customerId": "customer-123",
"accountId": "acc_123",
"payer": {
"name": "Orenda Ltd",
"accountNumber": "12345678"
},
"payee": {
"name": "Ada Lovelace",
"accountNumber": "87654321",
"sortCode": "040506"
},
"amount": "150.00",
"reference": "Invoice 1024",
"bankName": "Example Bank",
"scheduledDate": "2026/06/18",
"status": "COMPLETED",
"createdDateTime": "2026-06-18T10:32:00.000Z",
"updatedAt": "2026-06-18T10:35:12.481Z",
"programId": "orendabankingcircle",
"sandbox": false
},
{
"id": "a1b2c3d4-1111-2222-3333-444455556667",
"batchId": "b2c3d4e5-0000-1111-2222-333344445555",
"customerId": "customer-123",
"accountId": "acc_123",
"payer": {
"name": "Orenda Ltd",
"accountNumber": "12345678"
},
"payee": {
"name": "Grace Hopper",
"accountNumber": "11223344",
"sortCode": "040506"
},
"amount": "200.00",
"reference": "Invoice 1025",
"bankName": "Example Bank",
"scheduledDate": "2026/06/18",
"status": "FAILED",
"error": "Payment failed due to insufficient funds",
"createdDateTime": "2026-06-18T10:32:00.000Z",
"updatedAt": "2026-06-18T10:36:04.902Z",
"programId": "orendabankingcircle",
"sandbox": false
}
]
}
}{
"success": false,
"code": "VALIDATION_ERROR",
"message": "Program ID is required"
}{
"message": "Unauthorized"
}{
"success": false,
"code": "RESOURCE_NOT_FOUND",
"message": "Batch not found"
}Get a batch
Step 5. Returns a batch with its overall status and each item’s status. A batch reports CREATED, FUNDING_PENDING, FUNDED, PROCESSING, QUEUED, or the failure states FUNDING_FAILED and PARTIALLY_FAILED. Items are QUEUED, then SUCCESS or FAILED.
Opening a draft. If the id names a batch awaiting submission, the response carries a draft object instead of item rows: status (DRAFT or EXPIRED), paymentsCount, expiresAt, and the verified payments split into validPayments and invalidPayments, so a reviewer can see exactly what was checked before paying. Opened before verification completes, the draft has payloadStatus: "PENDING" and no payments. Once a draft has expired the payload is omitted (it’s held on its own retention clock) but the draft record remains. A draft belonging to another customer, or a customer’s own draft opened through the management route, is refused as if it didn’t exist.
curl --request GET \
--url https://api.next.orenda.finance/v1/batch-payments/{batchId} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.next.orenda.finance/v1/batch-payments/{batchId}', 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/{batchId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"success": true,
"data": {
"paymentsBatchItems": [
{
"id": "a1b2c3d4-1111-2222-3333-444455556666",
"batchId": "b2c3d4e5-0000-1111-2222-333344445555",
"customerId": "customer-123",
"accountId": "acc_123",
"payer": {
"name": "Orenda Ltd",
"accountNumber": "12345678"
},
"payee": {
"name": "Ada Lovelace",
"accountNumber": "87654321",
"sortCode": "040506"
},
"amount": "150.00",
"reference": "Invoice 1024",
"bankName": "Example Bank",
"scheduledDate": "2026/06/18",
"status": "COMPLETED",
"createdDateTime": "2026-06-18T10:32:00.000Z",
"updatedAt": "2026-06-18T10:35:12.481Z",
"programId": "orendabankingcircle",
"sandbox": false
},
{
"id": "a1b2c3d4-1111-2222-3333-444455556667",
"batchId": "b2c3d4e5-0000-1111-2222-333344445555",
"customerId": "customer-123",
"accountId": "acc_123",
"payer": {
"name": "Orenda Ltd",
"accountNumber": "12345678"
},
"payee": {
"name": "Grace Hopper",
"accountNumber": "11223344",
"sortCode": "040506"
},
"amount": "200.00",
"reference": "Invoice 1025",
"bankName": "Example Bank",
"scheduledDate": "2026/06/18",
"status": "FAILED",
"error": "Payment failed due to insufficient funds",
"createdDateTime": "2026-06-18T10:32:00.000Z",
"updatedAt": "2026-06-18T10:36:04.902Z",
"programId": "orendabankingcircle",
"sandbox": false
}
]
}
}{
"success": false,
"code": "VALIDATION_ERROR",
"message": "Program ID is required"
}{
"message": "Unauthorized"
}{
"success": false,
"code": "RESOURCE_NOT_FOUND",
"message": "Batch not found"
}Authorizations
The caller's access_token from authentication. Management API callers send the id_token. The program and environment come from the token.
Path Parameters
The batch id from submit.
Query Parameters
Required on the Management API, where the token carries no program: omitting it returns 400. Customer API callers resolve the program from their token and should omit it; a value sent there is ignored.