Skip to main content
GET
/
v1
/
batches
List batches
curl --request GET \
  --url http://localhost:8080/v1/batches \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "bat_cq1234567890abcdef",
      "merchant_id": "<string>",
      "uploaded_by": "<string>",
      "status": "uploaded",
      "file_name": "<string>",
      "file_format": "csv",
      "file_size": 123,
      "total_rows": 123,
      "valid_rows": 123,
      "invalid_rows": 123,
      "processed_rows": 123,
      "errors": [
        {
          "row": 123,
          "field": "<string>",
          "message": "<string>"
        }
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "completed_at": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "limit": 123,
    "offset": 123,
    "total": 123,
    "has_more": true
  }
}

Authorizations

Authorization
string
header
required

Merchant API key: ak_live_... or ak_test_...

Query Parameters

limit
integer
default:20

Maximum number of items to return

Required range: 1 <= x <= 100
offset
integer
default:0

Number of items to skip

Required range: x >= 0

Response

200 - application/json

Paginated list of batches

data
object[]
pagination
object