Get On-Ramp Status

Check the current status of an on-ramp transaction.

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

Endpoint

GET /v1/onramp/status/:reference

Authentication

Header

Value

x-api-key

Your API key

Path parameters

Parameter

Type

Description

reference

string

Your unique transaction reference

Example request

curl -X GET https://ramp-api.ivorypay.io/api/v1/onramp/status/550e8400-e29b-41d4-a716-446655440000 \
  -H "x-api-key: your_api_key"

const response = await fetch(
  "https://ramp-api.ivorypay.io/api/v1/onramp/status/550e8400-e29b-41d4-a716-446655440000",
  {
    method: "GET",
    headers: {
      "x-api-key": "your_api_key",
    },
  }
);

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

import requests

response = requests.get(
    "https://ramp-api.ivorypay.io/api/v1/onramp/status/550e8400-e29b-41d4-a716-446655440000",
    headers={
        "x-api-key": "your_api_key",
    },
)

print(response.json())

package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://ramp-api.ivorypay.io/api/v1/onramp/status/550e8400-e29b-41d4-a716-446655440000", nil)
	req.Header.Set("x-api-key", "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

{
  "statusCode": 200,
  "success": true,
  "message": "Query successful",
  "data": {
    "reference": "550e8400-e29b-41d4-a716-446655440000",
    "status": "SUCCESS",
    "email": "amina@example.com",
    "token": "USDT",
    "fiatCurrency": "NGN",
    "fiatAmount": 50000,
    "cryptoAmount": 31.25,
    "walletAddress": "0x742d35Cc6634C0532925a3b844Bc9e7595f2bD68",
    "blockchain": "BSC_MAINNET",
    "transactionHash": "0xabc123...",
    "createdAt": "2026-03-26T12:00:00.000Z"
  }
}

Transaction statuses

Status

Description

INITIATED

Transaction created, awaiting payment

PENDING

Payment session active

FIAT_PAYMENT_RECEIVED

Fiat payment confirmed

CRYPTO_PAYOUT_PROCESSING

Crypto being sent to wallet

SUCCESS

Crypto delivered — transaction complete

FAILED

Transaction failed

EXPIRED

Payment session expired

CANCELLED

Transaction was cancelled

While you can poll this endpoint, we strongly recommend using webhooks for real-time status updates.

PreviousInitiate On-Ramp NextGet Minimum On-Ramp Amount

Last updated 1 month ago

hashtagEndpoint

hashtagAuthentication

hashtagPath parameters

hashtagExample request

hashtagExample response