Embedded Wallets
SDK
Javascript
How to
Off Ramp
Transaction Detail

Off-Ramp Transaction Detail

This method allows you to retrieve detailed information about a specific off-ramp transaction using its ID.

Method Signature

async detailTransaction({transactionId: string, rampableAccessToken: string}): Promise<XellarOffRampTransactionDetailResponse>

Parameters

  • transactionId: string (required) - The unique identifier of the off-ramp transaction.
  • 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<XellarOffRampTransactionDetailResponse> - An object containing the detailed transaction information.

Example Usage

const transaction = await sdk.offRamp.detailTransaction({
  transactionId: 'f2672b92-XXXX-45fe-XXXX-f0c1279a3076',
  rampableAccessToken: 'your-rampable-access-token'
});
console.log(transaction);

Response Example

{
    "feeDetail": {
        "rate_amount": 15636.447900000001,
        "total_fee_amount": 0.3867141758923822,
        "total_fee_amount_in_currency": 6009.323667
    },
    "sender": {
        "id": "65857a1XXXXXX0f4005a817a",
        "name": "John Doe",
        "email": "john.doe@example.com",
        "walletAddress": "-"
    },
    "receiver": {
        "id": "64d344230277cbfe6XXXXXX2",
        "name": "Jane Smith",
        "email": "jane.smith@example.com",
        "accountNumber": "23123232123",
        "ifsc": "1",
        "achNumber": "1",
        "fedwireNumber": "",
        "ibanNumber": "1"
    },
    "offrampId": "f2672b92-XXXX-45fe-XXXX-f0c1279a3076",
    "inputAmount": 10,
    "inputAmountExact": 10,
    "inputCurrency": "usdc",
    "outputCurrency": "IDR",
    "outputAmount": 155394.45,
    "outputAmountExact": 149385.126333,
    "reason": "Salary",
    "description": "January 2024 Salary",
    "status": "completed",
    "organizationId": "-",
    "organizationName": "-",
    "blockchain": "polygon",
    "payOutWallet": "0xXXXXXXXXXXXXXXXX",
    "expiredDate": "2024-01-10T15:03:20.610Z",
    "cryptoId": "usdc-polygon",
    "useSmartContract": false,
    "blockchainType": "EVM",
    "activityHistory": [
        {
            "activity": "Signed by Payee",
            "status": "completed",
            "description": "Transaction signed successfully",
            "_id": "659eb08cb58XXXX",
            "updatedAt": "2024-01-10T14:58:20.619Z"
        },
        // ... more activity history entries
    ],
    "createdAt": "2024-01-10T14:58:20.619Z",
    "updatedAt": "2024-01-10T15:04:00.233Z",
    "id": "659eb08cb58XXXXXX2f84e91"
}
ℹ️

The response includes comprehensive transaction details including fee information, sender and receiver details, and a complete activity history of the transaction.

Additional Information

  • The transaction status can be one of: pending, processed, completed, need_information, refund or failed
  • activityHistory provides a chronological record of all state changes in the transaction
  • The feeDetail contains information about exchange rates and fees applied to the transaction
  • Transaction details remain accessible even after the transaction is completed or cancelled
  • When status is need_information, it means the off-ramp transaction needs more information to be processed

For more information, see the Rampable Off-Ramp Transaction Detail API Documentation (opens in a new tab).

Reply InfoAll Recipients