GET
/
v1
/
batch-payments
/
{batchId}
Get a batch
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": {
    "batchId": "b2c3d4e5-0000-1111-2222-333344445555",
    "status": "PROCESSING",
    "paymentsCount": 2,
    "createdAt": "2026-06-18T10:32:00Z",
    "items": [
      {
        "batchItemId": "item-001",
        "payee": {
          "name": "Ada Lovelace",
          "account": {
            "type": "uk",
            "sortCode": "040506",
            "accountNumber": "87654321"
          }
        },
        "amount": "150.00",
        "reference": "Invoice 1024",
        "status": "SUCCESS"
      },
      {
        "batchItemId": "item-002",
        "payee": {
          "name": "Grace Hopper",
          "account": {
            "type": "iban",
            "iban": "FR7630006000011234567890189",
            "bic": "AGRIFRPP"
          }
        },
        "amount": "200.00",
        "reference": "Invoice 1025",
        "status": "QUEUED"
      }
    ]
  }
}
{
"success": false,
"code": "UNAUTHORIZED",
"message": "Unauthorized"
}
{
"success": false,
"code": "RESOURCE_NOT_FOUND",
"message": "Batch not found"
}

Authorizations

Authorization
string
header
required

The user's access_token. The program and environment come from the token.

Path Parameters

batchId
string
required

The batch id from submit.

Response

The batch and its items

success
boolean
Example:

true

data
object