Get Off-Ramp Status

Check the current status of an off-ramp transaction.

Retrieves the current status and details of an off-ramp transaction by its reference.

Endpoint

GET /v1/offramp/status/:reference

Authentication

This endpoint accepts any one of three credentials in the Authorization header:

Credential	Header value
Merchant API key	Authorization: <api_key>
Business-user JWT	Authorization: Bearer <jwt>
Customer JWT	Authorization: Bearer <jwt>

Path parameters

Parameter	Type	Description
reference	string	Your unique transaction reference

Example request

cURL

curl -X GET https://ramp-api.ivorypay.io/api/v1/offramp/status/660e8400-e29b-41d4-a716-446655440001 \
  -H "Authorization: your_api_key"

Node.js

const response = await fetch(
  "https://ramp-api.ivorypay.io/api/v1/offramp/status/660e8400-e29b-41d4-a716-446655440001",
  {
    method: "GET",
    headers: {
      "Authorization": "your_api_key",
    },
  }
);

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

Python

import requests

response = requests.get(
    "https://ramp-api.ivorypay.io/api/v1/offramp/status/660e8400-e29b-41d4-a716-446655440001",
    headers={
        "Authorization": "your_api_key",
    },
)

print(response.json())

Go

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://ramp-api.ivorypay.io/api/v1/offramp/status/660e8400-e29b-41d4-a716-446655440001", nil)
	req.Header.Set("Authorization", "your_api_key")

	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

Example response

{
  "success": true,
  "message": "Query successful",
  "data": {
    "firstName": "Chidi",
    "lastName": "Nwankwo",
    "email": "[e-mail]",
    "refCode": "xyz789abc0",
    "reference": "660e8400-e29b-41d4-a716-446655440001",
    "transferDetails": {
      "token": "USDT",
      "blockchain": "BSC_MAINNET",
      "amountPayable": 62.5,
      "businessFee": 0,
      "platformFee": 0.3,
      "walletAddress": "0xIvoryPayDepositAddress...",
      "createdAt": "2026-03-26T12:00:00.000Z",
      "status": "SUCCESS",
      "fiatAmount": 100000,
      "expiresAt": "2026-03-26T13:00:00.000Z",
      "sessionId": "session_xyz789",
      "duration": 3600
    }
  }
}

Transaction statuses

Status	Description
INITIATED	Transaction created, awaiting crypto deposit
PENDING	Session active, waiting for crypto
CRYPTO_PAYMENT_RECEIVED	Crypto deposit detected on-chain
FIAT_PAYOUT_PROCESSING	Bank transfer in progress
SUCCESS	Fiat delivered to bank account
FAILED	Transaction failed
DECLINED	Transaction was declined
EXPIRED	Session expired before crypto was received