For the complete documentation index, see llms.txt. This page is also available as Markdown.

Get Transaction by ID

Get a specific transaction by its ID.

Retrieves the full details of a specific transaction.

Endpoint

GET /v1/transactions/:id

Authentication

Accepts either a merchant API key or a business-user JWT.

Header
Value

Authorization

<api_key> or Bearer <jwt>

Path parameters

Parameter
Type
Description

id

string

Transaction UUID. The path parameter is validated with NestJS ParseUUIDPipe and must be a well-formed UUID.

Example request

curl -X GET https://ramp-api.ivorypay.io/api/v1/transactions/f1e2d3c4-b5a6-7890-fedc-ba0987654321 \
  -H "Authorization: your_api_key"
const response = await fetch("https://ramp-api.ivorypay.io/api/v1/transactions/f1e2d3c4-b5a6-7890-fedc-ba0987654321", {
  method: "GET",
  headers: {
    "Authorization": "your_api_key",
  },
});

const data = await response.json();
console.log(data);
import requests

response = requests.get(
    "https://ramp-api.ivorypay.io/api/v1/transactions/f1e2d3c4-b5a6-7890-fedc-ba0987654321",
    headers={
        "Authorization": "your_api_key",
    },
)

print(response.json())

Example response

{
  "success": true,
  "message": "Query successful",
  "data": {
    "id": "f1e2d3c4-b5a6-7890-fedc-ba0987654321",
    "reference": "550e8400-e29b-41d4-a716-446655440000",
    "status": "SUCCESS",
    "feature": "ON_RAMP",
    "token": "USDT",
    "fiatCurrency": "NGN",
    "fiatAmount": 50000,
    "settledFiatAmount": 49750,
    "cryptoAmount": 31.25,
    "cryptoSettledAmount": 31.25,
    "network": "BSC_MAINNET",
    "walletAddress": "0x742d35Cc6634C0532925a3b844Bc9e7595f2bD68",
    "cryptoTransactionHash": "0xabc123...",
    "businessFeeInCrypto": 0,
    "platformFeeInCrypto": 0.15,
    "gasFee": 0.5,
    "environment": "LIVE",
    "createdAt": "2026-03-26T12:00:00.000Z",
    "updatedAt": "2026-03-26T12:05:00.000Z"
  }
}

Response fields

Fees are denominated in the transaction's crypto token: businessFeeInCrypto, platformFeeInCrypto, and gasFee. There are no email, platformFee, or businessFee columns on the transaction entity — customer-level data lives on the related customer record.

Last updated