Get Transaction (Off-Ramp and Crypto)
This endpoint retrieves details for both fiat (ramp) and cryptocurrency transactions using a transaction ID. Supports off-ramp (crypto→fiat) and crypto-to-crypto transfers.
Endpoint
GET {{baseURL}}/v1/ramp/transaction/{{transactionId}}
Headers
Header | Value | Required |
---|---|---|
Content-Type | application/json | Yes |
x-api-key | YOUR_API_KEY | Yes |
Path Parameter
Parameter | Type | Description |
---|---|---|
transactionId | string | Unique identifier of the transaction |
Successful Response 200 OK
for Off-Ramp
{
"message": "transaction fetched successfully",
"status": "success",
"data": {
"id": "8c684c17-ef91-4133-a624-53f31514f059",
"remark": "Monthly crypto payout",
"reason": "Salary",
"referenceNumber": "CRYTO123456",
"type": "SEND",
"state": "COMPLETED",
"quote": {
"id": "b39b64b9-3ca0-4566-b66b-a5fef8e81e7a",
"source": {
"currency": "USDC",
"country": "NG",
"amount": 15000
},
"target": {
"currency": "USDC",
"country": "US",
"amount": 59.28
},
"rate": 253.05,
"fee": {
"amount": 1850
}
},
"recipient": {
"name": "John Doe",
"firstName": "John",
"lastName": "Doe",
"relationship": "SELF",
"type": "CRYPTO",
"address": "0x1234567890abcdef12345XXXXXXXXXXXXX",
"network": {
"name": "Polygon",
"blockchain": "MATIC",
"tokenStandard": "ERC20"
},
"paymentChannel": "CRYPTO_WALLET",
"currency": "USDC",
"country": "US"
},
"created": "2025-02-27T14:17:48.038044",
"processed": "2025-02-27T14:20:49.712685"
}
}
Code | Message |
---|---|
400 | Bad request – invalid or missing fields |
401 | Unauthorized – invalid API key or token |
500 | Internal server error |