Gift Card (User)

Get gift card balance

Changed on
get/v1/gift-card/{cardId}/balance

Request

  • The document declares no server URL.
  • Auth
    HTTP bearer

Path parameters

cardIdstring required

Response

Gift card balance retrieved successfully

balancestring

Amount of balance available.

currencystring

The currency in which the balance is denoted.

enforcementDatestring date-time

Date and time when a certain rule or condition related to the balance will be enforced.

expirationDatestring date-time

Date and time when the balance or some part of it will expire.

type'VOUCHER' | 'UTXO' | 'GIFT_CARD' | 'PREPAID_CARD' | 'UTILITY_TOKEN'

Type of balance.

state'LIQUID' | 'FROZEN' | 'SENDING' | 'SENT' | 'SPENT'

Current state of the balance.

Changes

  • e825144e9ffdRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • eaa698f0f7cbRevision changes
    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status