List Card Balances & Transactions

Get Card Balances

Retrieve the balances for all customer-associated cards. This endpoint provides detailed balance information for each card related to the customer, ensuring a full overview of available and spent credit limits.

• HTTP Method: GET

• Endpoint: /api/v1/customer/cards/balances

Request Parameters

• PageSize (optional, default = 10): Number of records to be returned

• PageNumber (Optional, default = 1): Index of page to be returned

• CustomersID (Optional): Filter to return cards belonging to a specific CustomersID

Response

Example Response (Status Code: 200 OK)

{
  "id": 14619,
  "details": [
    {
      "id": 0,
      "CustomersReference": "string",
      "CardHolderName": "John Doe",
      "CardLast4": "1234",
      "CustomersID": 1234
      "currency": "usd",
      "totalBalance": 0,
      "availableBalance": 0,
      "pendingBalance": 0,
      "status": "Active"
    },
    // additional cards would be listed here
  ],
  "pageSize": 2,
  "pageNumber": 2,
  "numberOfPages": 0,
  "status": "1",
  "errors": []
}

Notes

• The balances returned are up-to-date at the time of request and may vary based on pending transactions.

---

Get Transactions

Retrieves a list of card transactions, with the ability to filter by CardsId and include a date range.

• Method: GET

• Endpoint: /api/v1/customer/cards/transactions

Request Query Parameters:

• CardsId: Use this parameter to filter transactions by the specific Card ID.

• fromDate (ISO 8601 UTC date, Optional): The start date for transaction filtering.

• toDate (ISO 8601 UTC date, Optional): The end date for transaction filtering.

• PageNumber: Indicate the page number to retrieve; defaults to 1 if not specified.

• PageSize: Define the number of transactions per page; defaults to 10 if not specified.

Example Response (Status Code: 200 OK)

{
  "id": 0,
  "details": [
    {
      "id": 0,
      "cardsId": 0,
      "amount": 0,
      "currency": "string",
      "description": "string",
      "dateTime": "2025-07-10T16:43:50.359Z",
      "bPending": true,
      "RefundTransactionsID": null
    }
  ],
  "pageSize": 10,
  "pageNumber": 1,
  "numberOfPages": 1,
  "status": "1",
  "errors": []
}

Note

• The transactions returned are reflective of all activity within the specified time frame and account for all completed, pending, and approved transactions.