Skip to main content

​
Get Transaction

This endpoint fetches the complete details of a specific Ramp transaction (either off-ramp or crypto-to-crypto) using its transactionId.

​
Endpoint

GET {{baseURL}}/v1/ramp/transaction/{{transactionId}}

​
Headers

HeaderValueRequiredDescription
Content-Typeapplication/jsonYesSpecifies that the request body is JSON.
x-api-keyYOUR_API_KEYYesAPI key for authentication.

​
Path Parameters

ParameterTypeRequiredDescription
transactionIdstringYesUnique identifier of the transaction.

​
Request Example

# Replace YOUR_TRANSACTION_ID with the actual transaction ID
curl --location '{{baseURL}}/v1/ramp/transaction/YOUR_TRANSACTION_ID' \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json'

​
Success Response (Off-Ramp) 200 OK

{
    "message": "transaction fetched successfully",
    "status": "success",
    "data": {
        "id": "8bd9a372-8d2b-494c-b0b2-7f590388b5ce",
        "type": "SEND",
        "category": "OFF_RAMP",
        "state": "COMPLETED",
        "referenceNumber": "YQXUA0ELOHXDL",
        "quote": {
            "id": "55ce26f5-96c1-40cd-9fd3-eba8402db7af",
            "source": {
                "currency": "USDC",
                "symbol": "USDC",
                "type": "CRYPTOCURRENCY",
                "amount": 0.12,
                "blockchain": "MATIC"
            },
            "target": {
                "currency": "NGN",
                "country": "NG",
                "type": "FIAT",
                "paymentChannel": "BANK_TRANSFER",
                "amount": 201.68
            },
            "rate": 0,
            "fees": {
                "amount": 0,
                "gas": {
                    "type": "MEDIUM",
                    "amount": 0.02
                }
            },
            "summary": {
                "total": 0.14
            }
        },
        "recipient": {
            "name": "NZAN  CHRISTIANA OMOM",
            "type": "BUSINESS",
            "account": {
                "bankName": "Guaranty Trust Bank",
                "sortCode": "058",
                "accountNumber": "0712617746"
            },
            "paymentChannel": "BANK_TRANSFER",
            "currency": "NGN",
            "country": "NG"
        },
        "created": "2025-01-08T12:23:51.908663",
        "processed": "2025-01-08T12:30:10.499526"
    }
}

​
Success Response (Crypto-to-Crypto) 200 OK

{
    "message": "transaction fetched successfully",
    "status": "success",
    "data": {
        "id": "8bd9a372-8d2b-494c-b0b2-7f590388b5ce",
        "type": "SEND",
        "category": "CRYPTOCURRENCY",
        "state": "COMPLETED",
        "referenceNumber": "YQXUA0ELOHXDL",
        "quote": {
            "id": "55ce26f5-96c1-40cd-9fd3-eba8402db7af",
            "source": {
                "currency": "USDC",
                "symbol": "USDC",
                "type": "CRYPTOCURRENCY",
                "amount": 0.12,
                "blockchain": "MATIC"
            },
            "target": {
                "currency": "USDC",
                "symbol": "USDC",
                "type": "CRYPTOCURRENCY",
                "amount": 0.12,
                "blockchain": "MATIC"
            },
            "rate": 0,
            "fees": {
                "amount": 0,
                "gas": {
                    "type": "MEDIUM",
                    "amount": 0.02
                }
            },
            "summary": {
                "total": 0.14
            }
        },
        "recipient": {
            "address": "0x018b979db90e60d2b2a4f4d3768aca4ec88043ef",
            "alias": "Testing",
            "blockchain": "MATIC",
            "symbol": "POL"
        },
        "created": "2025-01-08T12:23:51.908663",
        "processed": "2025-01-08T12:30:10.499526"
    }
}

​
Error Responses

HTTP StatusError CodeMessageDescription
401UNAUTHORIZEDMissing or invalid API keyThe x-api-key header is missing or incorrect.
404NOT_FOUNDTransaction not foundThe specified transaction ID does not exist.
500SERVER_ERRORInternal server errorAn unexpected error occurred on the server.