Reply to Off-Ramp Information Request
This method allows you to respond to an off-ramp transaction that requires additional information.
Method Signature
async replyInfo({message: string, rampableAccessToken: string}): Promise<XelalrOffRampsReplyInfo>
Parameters
message
:string
(required) - The information to reply. Maximum length is 300 characters.rampableAccessToken
:string
(optional) - The Rampable access token
A rampableAccessToken
is required if you want to use rampable operations and not setup HTTP Signature Authentication (Personal Token)
Returns
Promise<XelalrOffRampsReplyInfo>
- An object containing the updated off-ramp transaction details.
Example Usage
const updatedTransaction = await sdk.offRamp.replyInfo({
message: 'This is the new bank account number that should be correct -> 31233123',
rampableAccessToken: 'your-rampable-access-token'
});
);
console.log(updatedTransaction);
Response Example
{
"feeDetail": {
"rate_amount": 15786.0566975,
"total_fee_amount": 0.38008225328052986,
"total_fee_amount_in_currency": 6000
},
"sender": {
"id": "65535610a8bb6xxxxx7a9",
"name": "muhxxxkas",
"email": "muhxxxkas@gmail.com",
"walletAddress": "0xf487B61D988411xxxxxxxxx"
},
"receiver": {
"id": "65cf25633be7ba23cbb74cdd",
"name": "Postman Test",
"email": "xxxx-SGD@gmail.com",
"accountNumber": "23123232123",
"bankName": "ANEXT BANK PTE LTD.",
"ifsc": "",
"achNumber": "",
"fedwireNumber": "",
"ibanNumber": "",
"accountType": "Checking"
},
"offrampId": "8e6f2c6f-d91f-4655-xxxx-d978xxxxxxxxx",
"inputAmount": 0.123762,
"inputAmountExact": 0.123762,
"inputCurrency": "usdt",
"outputCurrency": "IDR",
"outputAmount": 1953.713948995995,
"outputAmountExact": 0,
"reason": "Test send - non hash",
"description": "Test description",
"status": "need_information",
"organizationId": "65d6df1xxxxxxxxxxxxxx",
"organizationName": "Rampable",
"blockchain": "polygon",
"routeId": "indodax",
"payOutWallet": "0x0bb863461821Xxxxxxxxxxxxxxxxxxx",
"expiredDate": "2024-05-06T05:01:28.772Z",
"cryptoId": "usdt-polygon",
"useSmartContract": false,
"blockchainType": "EVM",
"activityHistory": [
{
"activity": "Signed by Payee",
"status": "completed",
"description": "Transaction signed successfully",
"_id": "663860a47d9e87265b152fc7",
"updatedAt": "2024-05-06T04:47:35.871Z"
},
{
"activity": "Converted to",
"status": "completed",
"description": "Crypto assets received, confirmed by the network, and converted to fiat successfully",
"_id": "663860a47d9e87265b152fc8",
"updatedAt": "2024-05-06T04:47:35.871Z"
},
{
"activity": "Sent to recipient account",
"status": "need_information",
"description": "Payment is under process and will be transferred out to the recipient shortly",
"_id": "663860a47d9e87265b152fc9",
"updatedAt": "2024-05-06T04:46:28.775Z"
},
{
"activity": "Received by recipient account",
"status": "need_information",
"description": "Transaction is under process and will be transferred out to recipient shortly",
"_id": "663860a47d9e87265b152fca",
"updatedAt": "2024-05-06T04:46:28.775Z"
}
],
"disburstmentService": "bank",
"reference": "",
"adminNotesActivities": [
{
"message": "The bank account number is incorrect, please provide the correct bank account number",
"time": "2024-05-06T04:52:33.623Z",
"sender": "admin",
"_id": "663862117d9e87265b152fd0"
},
{
"message": "this is the new bank account number that should be correct -> 31233123",
"time": "2024-05-06T04:59:18.623Z",
"sender": "user",
"_id": "663863a6f630f8ea9ddc50ab"
}
],
"createdAt": "2024-05-06T04:46:28.778Z",
"updatedAt": "2024-05-06T04:59:18.627Z",
"transactionHash": "0x13b2cb743db6xxxxxxxxxxxxxxxxxxxxxx2bd",
"adminNotesDate": "2024-05-06T04:52:13.152Z",
"adminNotesReply": null,
"adminNotesReplyDate": null,
"id": "663860a47cxxxxxxxxxxxxfc6"
}
This method can only be used when the transaction status is 'need_information'. Attempting to reply when the transaction is in any other status will result in an error.
When a transaction requires additional information, the sender will receive an email notification with a URL to reply to the information request (redirecting to the Rampable dashboard).
Additional Information
- The method can only be used when the transaction status is
need_information
- Maximum message length is 300 characters
- After replying:
- The status may change to
completed
if the provided information is sufficient - The transaction may remain in
need_information
status if more information is required
- The status may change to
- The response includes a complete history of admin notes and activities related to the information request
For more information, see the Rampable Off-Ramp Reply Info API Documentation (opens in a new tab).