Skip to main content
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.

​
target_account_id
string
required

The ID of the account that will receive the redeemed value of the voucher.

​
redemption_value
object

The value to be redeemed from the voucher. If not specified, the entire remaining value of the voucher will be redeemed. For partial redemption, specify a value less than the voucher's current value.

​
metadata
object

Optional metadata to be associated with the redemption transaction.

Response

200 - application/json

The updated Voucher object after redemption, including the new status and redemption 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
​
redeemed_at
string
required

The timestamp when the voucher was last redeemed, in ISO 8601 format.

​
redeemed_to_account_id
string
required

The ID of the account that received the redeemed voucher value.

​
redemption_transaction_id
string
required

The ID of the transaction created for this redemption.

​
redeemed_value
object
required

The value that was redeemed in this transaction.

​
remaining_value
object
required

The remaining value on the voucher after this redemption.