Get transaction

Returns an offramp transaction

This endpoint will retrieve an individual offramp transaction for a user based on a specified transactionId.

Note:

• This endpoint necessitates the inclusion of the customerId parameter, as it is designed to retrieve an user's individual transactions.

• The executed rate will be shown only after a successful transaction.

Get an offramp transaction from transactionId.

POST https://api.onramp.money/onramp/api/v2/whiteLabel/offramp/transaction

Request Body

Name	Type	Description
transactionId*	String	Offramp transaction orderId
customerId*	String	Unique id received from /kyc/url

200: OK Success

{
    "status": 1,
    "code": 200,
    "data": {
        "transactionId": "433",
        "createdAt": "2023-11-21T13:50:29.000Z",
        "updatedAt": "2023-11-21T13:50:29.000Z",
        "fromAmount": "20",
        "toAmount": "8.94",
        "fromCurrency": "usdt",
        "toCurrency": "INR",
        "chain": "matic20",
        "fiatAccountId": "2",
        "status": "1",
        "transactionHash": null,
        "kycNeeded": 0
    }
}

400: Bad Request Missing required parameter

{
    "status": 0,
    "code": 400,
    "error": "Missing parameter -> customerId, transactionId."
}

500: Internal Server Error Internal Server Error

{
    "status": 0,
    "code": 500,
    "error": "Unable to fetch Offramp Transaction at the moment. Please try again after some time."
}

Response

{
    "status": 1,
    "code": 200,
    "data": {
        "transactionId": "12345",
        "customerId": "XRj7o1M_2",
        "createdAt": "2024-01-12T13:24:48.000Z",
        "updatedAt": "2024-01-12T13:48:53.000Z",
        "fromAmount": "1",
        "toAmount": "84.18",
        "fromCurrency": "usdt",
        "toCurrency": "INR",
        "chain": "matic20",
        "fiatAccountId": "9d7c64XXXXee",
        "status": "14",
        "transactionHash": "0x2XXXXX",
        "rate": 88.3,
        "kycNeeded": 0
    }
}

Explanation

• status -> 0 is for unsuccessful request, 1 is for a successful one.

• transactionId -> unique identifier of the transaction

• createdAt -> time at which the transaction was created.

• fromAmount -> Quantity of crypto received by the onramp.money.

• toAmount -> Actual fiat amount received by user

• fromCurrency -> symbol of the coin (e.g. USDT).

• toCurrency -> fiat used for the transaction.

• chain -> denotes which chain the coin was sent on (e.g. MATIC20).

• fiatAccountId -> Unique ID of fiat account to withdraw off-ramped fiat to

• status -> current status of Offramp transaction

  • -6 -> order refunded

  • -4 -> amount mismatch

  • -2 -> transaction abandoned.

  • -1 -> transaction time out.

  • 0 -> order created.

  • 1 -> order confirmed i.e. hash generated.

  • 2 or 10 or 11 -> hash found status.

  • 3 -> over limit (If the user sends a quantity of cryptocurrency that exceeds their KYC limit, their funds will be withheld until reviewed manually).

  • 4 or 12 -> crypto sold.

  • 5 or 13 -> fiat withdrawal initiated to bank

  • 6 or 14 -> fiat withdrawal processed.

  • 7 or 15 -> webhook sent

  • 17 -> provide alternate bank

  • 18 -> processing to alternate bank

  • 19 -> success

• transactionHash -> transaction hash related to this order.

• rate -> rate at which the order was executed, displayed only for successful transactions.

• kycNeeded -> Request for Information.