THthredd
Cards

List Card Balance

get/api/v1/cards/{publicToken}/balance

Request

  • Base URL
    https://cardsapi-uat-pub.globalprocessing.net
  • URL
    https://cardsapi-uat-pub.globalprocessing.net/api/v1/cards/{publicToken}/balance
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://uatists.globalprocessing.net/connect/token scopes: readWrite

Path parameters

publicTokenstring required

Response

Success

currencyCodestring nullable

Currency code (3-letter format)

cardBalancenumber double

Actual balance of the Card (including blocked amount)

pendingAmountnumber double

Blocked Amount (i.e. part of available balance which cannot be used)

availableBalancenumber double

Available Balance

Example response

{
  "currencyCode": "GBP",
  "cardBalance": 1000,
  "availableBalance": 1000
}

Changes

No recorded changes to this operation across all 2 revisions of this API.