POST /transaction/redeem-request
Use this API to request a IDRX redeem transaction.
Parameters
txHash(String):This parameter is the transaction hash for the burning transaction of the token.
networkChainId(String):This parameter identifies the blockchain network on which the redemption transaction occurred.
amountTransfer(String):This parameterspecifies the amount of fiat currency that was transferred as part of the redemption process. It represents the monetary value equivalent to the redeemed stable tokens.
bankAccount(String):This parameter is the bank account number provided by the user or recipient, where the fiat funds are received after the redemption process.
bankCode(String):This parameter represents the code associated with the recipient's bank. It is used to identify the specific bank where the provided
bankAccountis held. Please use the Get Methods API to get a list of bank codes and bank namesbankName(String):This parameter refers to the name of the recipient's bank. Please use the Get Methods API to get a list of bank codes and bank names
bankAccountName(String):This parameter represents the name associated with the recipient's bank account. It specifies the legal or account holder's name for the provided bank account number.
walletAddress(String):This parameter is the recipient's blockchain wallet address. While the fiat funds are sent to the bank account, this parameter provides the corresponding blockchain wallet address, allowing cross-verification and transparency.
notes(String):When redeeming to a bank account with a different account holder name than your IDRX account, please fill in this parameter to describe the reason or purpose of the transaction.
memberId(Number, optional):Organization keys only. The
idof one of your organization users (from Onboarding). The redeem request is submitted for that user: the burn must come from that user's wallet, andbankAccount+bankCodemust match a bank account registered on that user through Add Bank Account; the registered account is used for the payout, whateverbankNameandbankAccountNamesay. An account that is not registered on the user is rejected with400 bank account is not registered on this member, and a user that is not a verified user of your organization with400 memberId is not a member of your organization. OmitmemberIdto redeem for the key holder.
Example Request
Payload
Response
If the request is successful, the response will be as shown below:
Retrying safely
Each burn transaction can only be redeemed once. If you submit a txHash that has already been redeemed, the request does not fail and does not create a second redeem — it returns 200 with a different shape:
This makes retries safe: if a request times out and you are unsure whether it went through, resubmit the same txHash. Check for data.alreadyExists to tell a fresh redeem (201) from a replay (200), and use redeemRequestId to look up the original.
To check the status of your transaction, you can use the Transaction History API.
Last updated
