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": "<string>",
      "merchant_id": "<string>",
      "status": "uploaded",
      "file_name": "<string>",
      "file_format": "csv",
      "file_size": 123,
      "total_rows": 123,
      "valid_rows": 123,
      "invalid_rows": 123,
      "processed_rows": 123,
      "source_currency": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "completed_at": "2023-11-07T05:31:56Z",
      "confirmed_at": "2023-11-07T05:31:56Z",
      "expires_at": "2023-11-07T05:31:56Z"
    }
  ],
  "has_more": true,
  "next_cursor": "<string>"
}

Authorizations

​
Authorization
string
header
required

Merchant API key: ak_live_* (production) or ak_test_* (sandbox).

Query Parameters

​
limit
integer
default:20

Maximum number of items to return (default 20, max 100).

Required range: x <= 100
​
cursor
string

Pagination cursor from previous response's next_cursor.

​
status
enum<string>
Available options:
uploaded,
validating,
validated,
validation_failed,
confirmed,
processing,
completed,
partial,
failed,
cancelled

Response

Paginated list of batches.

​
data
object[]
required
​
has_more
boolean
required
​
next_cursor
string