Redeem
If this entity information is missing, the endpoint returns a 401 Unauthorized error.
POST
/redeem
This endpoint initiates a token redemption process by generating an unsigned redeem transaction. It performs several checks: validating input parameters, verifying the recipient's token allowance, resolving the bank account details, and sending a notification email. The unsigned transaction details are then returned to the client for signing and broadcasting.
Headers
Content-Type
application/json
Authorization
Bearer <api_key>
Body
recipient
string
The wallet address of the user (must be a valid EVM address).
amount
number
The amount of tokens to redeem.
assetType
string
The type of asset to redeem. Must be one of the enums (e.g., "ENSC"
, "USDC"
, "USDT"
, "LSK"
).
payoutEmail
string
Email address to which the payout reference pvRef
will be sent (Required only if assetType
is ENSC
. For non‑ENSC assets, this field is omitted.).
bank
string
The local Nigerian bank code gotten from the get-banks endpoint (Conditionally Required: Required only if assetType
is ENSC
(e.g., '058'
, '044'
).
accountNumber
string
The bank account number (Required only if assetType
is ENSC
(e.g., '0123456789'
, '0690000032'
).
Example 1
{
"recipient": "0xRecipientAddressABC123",
"amount": 100,
"assetType": "ENSC",
"payoutEmail": "user@example.com",
"bank": "058",
"accountNumber": "0123456789"
}
Example 2
{
"recipient": "0xRecipientAddressABC123",
"amount": 50,
"assetType": "USDC"
}
Common Error Responses
Last updated