Get Balance Details of a Card

GET 
/api/v1/cards/card/balance

Retrieves the balance details of a specified card. This includes various components such as the total limit, available balance, spent amount, and more.

Request

Query Parameters

card_id Card Id

The unique identifier of the card for which balance details are being requested.

Responses

200

Successful Response

application/json

Schema

Schema

card_id object required

The unique identifier of the card.

anyOf

MOD1

string

MOD2

string

limit Limitrequired

The total spending limit of the card over its entire lifetime.

available Availablerequired

The current available balance on the card.

spend Spendrequired

The total amount spent using the card. This is equivalent to the 'used' amount in other endpoints.

opening_balance Opening Balancerequired

The balance of the card at the time of its issuance.

topup_balance Topup Balancerequired

The total amount added to the card through top-ups.

limit_per_transaction Limit Per Transactionrequired

The maximum amount allowed for a single transaction on the card.

pending_balance Pending Balancerequired

The total amount in transactions that are currently pending approval.

fees_balance Fees Balancerequired

The total sum of fees incurred by the card.

incoming_balance Incoming Balancerequired

The total amount of external payments received on the card.

withdrawal_balance Withdrawal Balancerequired

The total amount withdrawn from the card, including decrease limit operations.

Example (from schema)

{
  "card_id": "string",
  "limit": 0,
  "available": 0,
  "spend": 0,
  "opening_balance": 0,
  "topup_balance": 0,
  "limit_per_transaction": 0,
  "pending_balance": 0,
  "fees_balance": 0,
  "incoming_balance": 0,
  "withdrawal_balance": 0
}

422

Validation Error

application/json

Schema

Schema

detail object[]
Array [
loc object[]required
Array [
anyOf
MOD1
string
MOD2
integer
]
msg Messagerequired
type Error Typerequired
]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...