List all batches

Changed on
get/batches

Request

  • Base URL
    https://gateway.pmnts-sandbox.io/v1.0
  • URL
    https://gateway.pmnts-sandbox.io/v1.0/batches
  • Auth
    HTTP basic

Query parameters

limitinteger

The number of records to return per request (page) - the maximum per request is 50.

offsetinteger

The pagination offset. For example, offset=10, limit=10 will return records 100 to 110

Response

200

OR

Example response

{
  "total_records": 2128,
  "page": 1,
  "successful": true,
  "test": true,
  "records": 2,
  "response": [
    {
      "created_at": "2018-01-30T01:58:52+11:00",
      "id": "071-BF-PGGSPBF1",
      "type": "PURCHASE",
      "status": "Error",
      "filename": "BATCH-v1-PURCHASE-TEST-20180101-test4.csv",
      "process_date": "2018-01-01",
      "reference": "test4"
    }
  ],
  "total_pages": 1024
}

Changes