POST
/
v1
/
service
/
voucher
/
{voucherId}
/
redeem
Redeem a voucher (full or partial)
curl --request POST \
  --url https://api.nxos.io/v1/service/voucher/{voucherId}/redeem \
  --header 'Content-Type: application/json' \
  --data '{
  "target_account_id": "<string>",
  "redemption_value": {
    "amount": "<string>",
    "asset_code": "<string>"
  },
  "metadata": {}
}'
{
  "voucher_id": "<string>",
  "value": {
    "amount": "<string>",
    "asset_code": "<string>"
  },
  "expires_at": "<string>",
  "provider_name": "<string>",
  "funding_source_account": "<string>",
  "status": "ACTIVE",
  "redeemed_at": "<string>",
  "redeemed_to_account_id": "<string>",
  "redemption_transaction_id": "<string>",
  "redeemed_value": {
    "amount": "<string>",
    "asset_code": "<string>"
  },
  "remaining_value": {
    "amount": "<string>",
    "asset_code": "<string>"
  }
}

Path Parameters

​
voucherId
string
required

The unique identifier of the voucher to redeem.

Body

application/json

The details required for redeeming the voucher, including the target account and redemption value.

The body is of type object.

Response

200 - application/json

The updated Voucher object after redemption, including the new status and redemption details.

The response is of type object.