Get All Cards

Endpoint

GET/api/v1/merchant/cards/

This endpoint outputs a list of all cards.

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/cards/?page=1&min_created=2024-01-01&max_created=2024-01-31

Response

{
  "results": [
    {
      "id": "string",
      "currency": "string",
      "lastFour": "string",
      "externalCustomerId": "string",
      "cardholderName": "string",
      "cardName": "string",
      "cardDesign": "string",
      "cardType": "string",
      "status": "string",
      "created": "string"
    }
  ],
  "count": 0,
  "next": "string",
  "previous": "string"
}

Response Codes

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