List Batches

GET

batches

List batches

curl --request GET \
  --url https://api.antonpayments.com/v1/batches \
  --header 'Authorization: Bearer <token>' \
  --header 'DPoP: <api-key>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>', DPoP: '<api-key>'}};

fetch('https://api.antonpayments.com/v1/batches', 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.antonpayments.com/v1/batches",
  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>",
    "DPoP: <api-key>"
  ],
]);

$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.antonpayments.com/v1/batches"

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("DPoP", "<api-key>")

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

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

	fmt.Println(string(body))

}

{
  "data": [
    {
      "id": "bat_01HX8Z9K0M2N3P4Q5R6S7T8UBT",
      "merchant_id": "<string>",
      "uploaded_by": "<string>",
      "status": "uploaded",
      "file_name": "payroll_2026_04_15.csv",
      "file_format": "csv",
      "file_size": 123,
      "created_at": "2026-04-15T14:30:00Z",
      "updated_at": "2026-04-15T14:30:00Z",
      "total_rows": 123,
      "valid_rows": 123,
      "invalid_rows": 123,
      "warning_rows": 123,
      "skipped_rows": 123,
      "processed_rows": 123,
      "summary": {
        "new_beneficiaries": 123,
        "matched_beneficiaries": 123,
        "existing_beneficiaries": 123,
        "methods": {},
        "estimated_debits": [
          {
            "currency": "USD",
            "amount": "1234.56",
            "fx_rows": 123,
            "same_currency_rows": 123,
            "rate_timestamp": "2026-04-15T14:30:00Z"
          }
        ],
        "fx_markup_bps": 123,
        "balance_check": {}
      },
      "source_currency": "USD",
      "total_amount": "12345.67",
      "total_currency": "USD",
      "current_row_index": 123,
      "expires_at": "2026-04-15T14:30:00Z",
      "confirmed_at": "2026-04-15T14:30:00Z",
      "confirmed_by": "<string>",
      "cancelled_at": "2026-04-15T14:30:00Z",
      "cancelled_by": "<string>",
      "processing_started_at": "2026-04-15T14:30:00Z",
      "completed_at": "2026-04-15T14:30:00Z"
    }
  ],
  "has_more": true,
  "next_cursor": "<string>"
}

Authorizations

DPoP

string

header

required

Per-request DPoP proof JWT (RFC 9449). MUST accompany the Authorization: DPoP <access_token> header on every protected operation. The proof is signed by the merchant's private DPoP key and carries htm, htu, iat, jti, and ath claims.

Query Parameters

limit

integer

default:20

Items per page. Maximum 100.

Required range: 1 <= x <= 100

cursor

string

Opaque cursor returned by a previous list response. Omit for the first page.

status

enum<string>

Available options:

uploaded,

validating,

validated,

validation_failed,

confirmed,

processing,

completed,

partial,

failed,

cancelled

created_after

string<date-time>

RFC 3339 timestamp. Returns batches with created_at >= this. RFC 3339 / ISO 8601 timestamp in UTC.

Example:

"2026-04-15T14:30:00Z"

created_before

string<date-time>

RFC 3339 timestamp. Returns batches with created_at <= this. RFC 3339 / ISO 8601 timestamp in UTC.

Example:

"2026-04-15T14:30:00Z"

Response

Paginated list of batches.

data

object[]

required

Array of results for this page. Element schema varies by endpoint.

Show child attributes

has_more

boolean

required

Whether more results exist beyond this page.

next_cursor

string

Cursor for the next page. Present only when has_more is true.

⌘I

List batches

curl --request GET \
  --url https://api.antonpayments.com/v1/batches \
  --header 'Authorization: Bearer <token>' \
  --header 'DPoP: <api-key>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>', DPoP: '<api-key>'}};

fetch('https://api.antonpayments.com/v1/batches', 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.antonpayments.com/v1/batches",
  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>",
    "DPoP: <api-key>"
  ],
]);

$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.antonpayments.com/v1/batches"

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("DPoP", "<api-key>")

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

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

	fmt.Println(string(body))

}

{
  "data": [
    {
      "id": "bat_01HX8Z9K0M2N3P4Q5R6S7T8UBT",
      "merchant_id": "<string>",
      "uploaded_by": "<string>",
      "status": "uploaded",
      "file_name": "payroll_2026_04_15.csv",
      "file_format": "csv",
      "file_size": 123,
      "created_at": "2026-04-15T14:30:00Z",
      "updated_at": "2026-04-15T14:30:00Z",
      "total_rows": 123,
      "valid_rows": 123,
      "invalid_rows": 123,
      "warning_rows": 123,
      "skipped_rows": 123,
      "processed_rows": 123,
      "summary": {
        "new_beneficiaries": 123,
        "matched_beneficiaries": 123,
        "existing_beneficiaries": 123,
        "methods": {},
        "estimated_debits": [
          {
            "currency": "USD",
            "amount": "1234.56",
            "fx_rows": 123,
            "same_currency_rows": 123,
            "rate_timestamp": "2026-04-15T14:30:00Z"
          }
        ],
        "fx_markup_bps": 123,
        "balance_check": {}
      },
      "source_currency": "USD",
      "total_amount": "12345.67",
      "total_currency": "USD",
      "current_row_index": 123,
      "expires_at": "2026-04-15T14:30:00Z",
      "confirmed_at": "2026-04-15T14:30:00Z",
      "confirmed_by": "<string>",
      "cancelled_at": "2026-04-15T14:30:00Z",
      "cancelled_by": "<string>",
      "processing_started_at": "2026-04-15T14:30:00Z",
      "completed_at": "2026-04-15T14:30:00Z"
    }
  ],
  "has_more": true,
  "next_cursor": "<string>"
}

Overview

Cross-Cutting

Reference Data

Beneficiaries

Instruments

Intelligence

Verifications

Payouts

Batches

Balances

Accounts

Webhooks

Pricing

FX

Corridors

Authorizations

Query Parameters

Response