v1

latestOpenAPI 3.0.0Apache-2.02026-07-17584343.2 KB
Voucher (User)

Get voucher balance

get/v1/voucher/{cardId}/balance

Path parameters

cardIdstring required

Response

Voucher 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.