Get All Transactions

Endpoint

GET/api/v1/merchant/transactions/

This endpoint outputs a list of transactions incurred by all the cards within the card program.

Query Parameters

Name	Type	Required	Description
page	float	❌	Defaults to 1. The page number to retrieve in a paginated response. Must be ≥ 1.
min_created	string	❌	The start date for filtering records, formatted as YYYY-MM-DD. Only records from this date onwards will be retrieved.
max_created	string	❌	The end date for filtering records, formatted as YYYY-MM-DD. Only records up to this date will be retrieved.

Example Request

GET /api/v1/merchant/transactions/?page=1&min_created=2024-01-01&max_created=2024-01-31

Response

{
  "results": [
    {
      "id": "string",
      "external_transaction_id": "string",
      "card_id": "string",
      "bill_amount": 0,
      "bill_currency": "string",
      "cardholder_name": "string",
      "amount": "string",
      "currency": "string",
      "status": "string",
      "created": "string"
    }
  ],
  "count": 0,
  "next": "string",
  "previous": "string"
}

Response Codes

Status Code	Description
200 OK	Successfully retrieved transactions.
400 Bad Request	Invalid request parameters.
401 Unauthorized	Authentication failed.
500 Internal Server Error	Server error.