Skip to main content
POST
/
v1
/
service
/
voucher
Mint a new voucher
curl --request POST \
  --url https://api.nxos.io/v1/service/voucher \
  --header 'Content-Type: application/json' \
  --data '{
  "value": {
    "amount": "<string>",
    "asset_code": "<string>"
  },
  "expires_at": "<string>",
  "provider_name": "<string>",
  "funding_source_account_id": "<string>"
}'
{
  "voucher_id": "<string>",
  "value": {
    "amount": "<string>",
    "asset_code": "<string>"
  },
  "expires_at": "<string>",
  "provider_name": "<string>",
  "funding_source_account": "<string>",
  "status": "ACTIVE"
}

Body

application/json

The details required to mint a new voucher.

​
value
object
required

The value of the voucher to be minted.

​
provider_name
string
required

The name of the voucher provider or issuing system.

​
funding_source_account_id
string
required

The account ID from which funds will be sourced to back the voucher.

​
expires_at
string

The expiration date of the voucher in ISO 8601 format. If not provided, a default expiration period may be applied.

Response

200 - application/json

The minted Voucher object containing all relevant details.

​
voucher_id
string
required

Unique identifier for the voucher.

​
value
object
required

The value of the voucher.

​
expires_at
string
required

The expiration date of the voucher in ISO 8601 format.

​
provider_name
string
required

The name of the voucher provider or issuing system.

​
funding_source_account
string
required

The account ID from which funds were sourced to back the voucher.

​
status
enum<string>
required

The current status of the voucher.

Available options:
ACTIVE,
PARTIALLY_REDEEMED,
FULLY_REDEEMED,
EXPIRED,
CANCELLED
⌘I