GET
/
v1
/
batch-payments
List batches
curl --request GET \
  --url https://api.next.orenda.finance/v1/batch-payments \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.next.orenda.finance/v1/batch-payments"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
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));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.next.orenda.finance/v1/batch-payments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.next.orenda.finance/v1/batch-payments"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.next.orenda.finance/v1/batch-payments")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.next.orenda.finance/v1/batch-payments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "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

Authorization
string
header
required

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

Query Parameters

limit
integer
default:50

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 >= 1
nextToken
string

Pagination token returned by a previous response.

lookbackDays
integer
default:30

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

Response

Batches

success
boolean
Example:

true

data
object