Skip to main content
GET
/
v1
/
batches
List batches
curl --request GET \
  --url https://api.antonpayments.com/v1/batches \
  --header 'Authorization: Bearer <token>'
{ "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", "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

​
Authorization
string
header
required

API keys are opaque strings prefixed by environment:

  • ak_live_* — production keys, accepted only on api.antonpayments.com.
  • ak_test_* — sandbox keys, accepted only on api.antonpayments.dev.

Include your key in the Authorization header: Bearer ak_test_....

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

Response

Paginated list of batches.

​
data
object[]
required

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

​
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.