Skip to main content
GET
/
v1
/
onramps
/
{onrampId}
Fetch an onramp
curl --request GET \
  --url https://api.paystack.com/v1/onramps/{onrampId} \
  --header 'Authorization: Bearer <token>'
{
  "status": true,
  "message": "Onramp fetched successfully",
  "code": "ok",
  "data": {
    "id": "onr_01KPBH802PXQQXT8ASJGE0QX2K",
    "reference": "INV-2026-001",
    "status": "awaiting_deposit",
    "quote_id": "quo_01KPBK123456789ABCDEFG",
    "rate_source": "quoted",
    "customer": {
      "id": "cust_seed_alice",
      "type": "individual",
      "name": "Alice Johnson",
      "email": "alice.seed@globalstack.mock",
      "tier": "tier_2",
      "created_at": "2026-04-16T16:14:08.000Z",
      "updated_at": "2026-04-16T16:14:08.000Z"
    },
    "wallet": {
      "id": "wal_seed_alice_usdc",
      "currency": "USDC",
      "label": "USDC Wallet"
    },
    "source_amount": "10000.00",
    "source_currency": "NGN",
    "destination_currency": "USDC",
    "rate": "0.000000",
    "deposit_instruction": {
      "version": 1,
      "type": "fiat",
      "accountName": "GLOBALSTACK / FX ENGINE",
      "accountNumber": "0123456789",
      "bankName": "Access Bank",
      "bankCode": "000014",
      "expiresAt": "2026-06-03T16:14:08.000Z"
    },
    "metadata": {
      "order_id": "ord_demo_001"
    },
    "created_at": "2026-04-16T16:16:03.000Z",
    "updated_at": "2026-04-16T16:16:03.000Z",
    "payment_instrument": null,
    "destination_amount": "0.000000",
    "rate_locked_until": null,
    "failure_reason": null
  },
  "meta": {
    "request_id": "req_01HXYZ4K5ABCDEFGHJKLMNPQRS",
    "timestamp": "2026-05-14T15:43:55.732Z",
    "version": "1"
  }
}

Authorizations

Authorization
string
header
required

API key issued during merchant onboarding.

Path Parameters

onrampId
string
required
Pattern: [^\/#\?]+?

Response

Onramp fetched successfully

status
enum<boolean>
required
Available options:
true
Example:

true

message
string
required

Human-readable summary

Example:

"Onramp fetched successfully"

code
enum<string>
required
Available options:
ok
Example:

"ok"

data
object
required
meta
object
required