[Deprecated] Get Order

This API is designed to retrieve order details using a unique Transaction ID, allowing developers and merchants to obtain specific information related to individual orders.

getByTransactionId

GET /api/v1/external/orders/getByTransactionId

This API is designed to retrieve order details using a unique Transaction ID, allowing developers and merchants to obtain specific information related to individual orders.

Query Parameters

Name	Type	Description
id*	String	MerchantTransactionId from the Create order API.

200: OK

{
    "status": "success",
    "data": {
        "id": "109094a9-6a14-42f3-ae13-165c8c401638",
        "merchantTransactionId": "dshcucfhweedhbdvsyssdse7fc6sd9a14",
        "type": "buy",
        "status": "created",
        "amount": 0.5,
        "currency": "EUR",
        "baseCurrency": "EUR",
        "baseCurrencyAmount": 0.5,
        "exchangeRate": 1,
        "cryptocurrency": "USDT",
        "cryptocurrencyAmount": 0.5275597197602768,
        "cryptoExchangeRate": 1.0551194395205536,
        "redirectUrl": ""
    }
}

Response Fields:

Field	Description
status	Indicates the status of the response, typically success for successful requests.
data	Contains the details of the order retrieved.
id	The unique ID of the order in RampNow’s system.
merchantTransactionId	The unique Transaction ID provided in the request.
type	Type of the order, e.g., buy.
status	The status of the order; it can be: Created: Order is created and payment is not initiated yet. payment_success: Payment made successfully and Transaction is completed. Cancelled: Customer cancelled the transaction without a payment or transaction is expired without any successful payment. Pending: Transaction is waiting to get completed; all transactions get completed within a few minutes (may 0-8 minutes). Sofort gets completed within 3 working days.
amount	The amount in the specified currency.
currency	The fiat currency of the order.
baseCurrency	The base fiat currency used for the transaction.
baseCurrencyAmount	The amount in the base currency.
exchangeRate	The exchange rate used for the transaction.
cryptocurrency	The type of cryptocurrency involved in the order.
cryptocurrencyAmount	The amount in cryptocurrency.
cryptoExchangeRate	The exchange rate of the cryptocurrency.
redirectUrl	The URL to which the user is redirected.

Usage:

To retrieve details of an order, construct the URL with the required Transaction ID and send a GET request with a valid Access Token in the Authorization header.

Considerations:

• Ensure that the Access Token is valid and has the necessary permissions to access this endpoint.

• Verify that the Transaction ID is correctly specified in the request parameter.

Conclusion:

The GetOrderByID API provides a robust and secure means for developers and merchants to retrieve detailed and specific information related to orders, aiding in efficient order management and oversight within the RampNow ecosystem.