On-Ramp Transaction Detail
This method allows you to retrieve detailed information about a specific on-ramp transaction using its ID.
Method Signature
async detailTransaction(transactionId: string): Promise<OnRampTransaction>
Parameters
transactionId
: string
(required) - The unique identifier of the on-ramp transaction.
Returns
Promise<OnRampTransaction>
- An object containing the detailed transaction information.
Example Usage
const transaction = await sdk.onRamp.detailTransaction('d27547ff-XXXX-XXXX-XXXX-c276b8730383');
console.log(transaction);
Response Example
{
"onrampId": "d27547ff-XXXX-XXXX-XXXX-c276b8730383",
"acceptanceMethod": "virtual_account_bni",
"feeDetail": {
"rate_amount": 15676.51352,
"total_fee_amount": 224.5397227839727,
"total_fee_amount_in_currency": 3520000.0000000005
},
"receiver": {
"id": "64c422d5e7XXXXXXXX",
"name": "",
"email": "",
"phoneNumber": "",
"walletAddress": "GDC2QXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
},
"inputAmount": 16000,
"inputAmountExact": 16000,
"inputCurrency": "IDR",
"outputCurrency": "usdc",
"outputAmount": 1.0189502456147725,
"outputAmountExact": 1.006213367544588,
"reason": "Salary",
"description": "Salary for January 2024",
"status": "cancelled",
"organizationId": "-",
"organizationName": "-",
"blockchain": "stellar",
"userId": "XXXXXXXXXXXXXXX",
"externalOrderId": "1706604XXXXXXXXX",
"expiredDate": "2024-01-30T08:56:32.611Z",
"cryptoId": "usdc-stellar",
"useSmartContract": false,
"blockchainType": "STELLAR",
"memo": "",
"activityHistory": [
{
"activity": "Paid by Payee",
"status": "failed",
"description": "Transaction has been cancelled",
"_id": "65b8b894e70322c4c3fe6059",
"updatedAt": "2024-01-30T08:51:32.615Z"
},
{
"activity": "Converted to",
"status": "failed",
"description": "Transaction has been cancelled",
"_id": "65b8b894e70322c4c3fe605a",
"updatedAt": "2024-01-30T08:51:32.616Z"
},
{
"activity": "Sent to recipient wallet",
"status": "failed",
"description": "Transaction has been cancelled",
"_id": "65b8b894e70322c4c3fe605b",
"updatedAt": "2024-01-30T08:51:32.616Z"
},
{
"activity": "Received by recipient",
"status": "failed",
"description": "Transaction has been cancelled",
"_id": "65b8b894e70322c4c3fe605c",
"updatedAt": "2024-01-30T08:51:32.616Z"
}
],
"acceptanceDetail": {
"trans_id": "ag9ff9dXXXXXXXXXX",
"merchant_code": "FmXXXXXX",
"order_id": "1706604XXXXXXXX",
"no_reference": "1706604XXXXXXXX",
"amount": "16000",
"frontend_url": "https://app-dev.rampable.co/fm?data=XXXXXXXXXXXXXXXXXXXXXXM3YTIifQ==",
"signature": "1f5ef0d30XXXXXXXXXXXXXXXXXXXX",
"is_custom_page": false
},
"clientName": "Xellar",
"clientId": "65383b6dXXXXXXXXXXXX",
"createdAt": "2024-01-30T08:51:32.648Z",
"updatedAt": "2024-01-30T08:56:32.951Z",
"id": "65b8b894eXXXXXXXXXXXXXXX"
}
ℹ️
The response includes comprehensive transaction details including fee information, receiver details, and a complete activity history of the transaction.
Additional Information
- The transaction status can be one of:
pending
,processed
,completed
, orfailed
- Activity history provides a chronological record of all state changes in the transaction
- The
acceptanceDetail
field contains payment-specific information when applicable - Transaction details remain accessible even after the transaction is completed or cancelled
For more information, see the Rampable On-Ramp Transaction Detail API Documentation (opens in a new tab).