List onramps

curl --request GET \
  --url https://api.paystack.com/v1/onramps \
  --header 'Authorization: Bearer <token>'

{
  "status": true,
  "message": "Onramps 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": {
    "page": 1,
    "per_page": 50,
    "total": 137,
    "has_more": false,
    "request_id": "req_01HXYZ4K5ABCDEFGHJKLMNPQRS",
    "timestamp": "2026-05-14T15:43:55.732Z",
    "version": "1"
  }
}

Onramps

List onramps

List onramps, newest first. Results are scoped to the authenticated integration.

All filters are optional. With no filters every onramp for the integration is returned (paginated).

Filter behavior

customer_id — restricts to onramps for a single customer. Must be a valid cust_… id. An unknown id returns an empty page (200, data: []), not 404.
status — restricts to a single lifecycle status. One of created, awaiting_deposit, processing, temporary_failure, success, failed, returned.
created_after / created_before — either a YYYY-MM-DD calendar date (UTC, inclusive: created_after matches at or after 00:00:00, created_before at or before 23:59:59.999) or a full ISO 8601 UTC timestamp ending in Z (e.g. 2026-04-16T16:16:03Z), used as the exact instant.

Pagination

page — 1-indexed page number. Defaults to 1. Must be between 1 and 1,000,000.
per_page — page size. Defaults to 50. Must be between 1 and 200.

The response carries pagination metadata under meta:

"meta": {
  "request_id": "req_...",
  "timestamp": "...",
  "version": "1",
  "page": 1,
  "per_page": 50,
  "total": 137,
  "has_more": true
}

has_more is true when at least one more page is available.

Ordering

Results are sorted by created_at DESC, id DESC (newest first, deterministic on ties).

Example

GET /v1/onramps?status=awaiting_deposit&customer_id=cust_seed_alice&page=1&per_page=50

GET

onramps

List onramps

curl --request GET \
  --url https://api.paystack.com/v1/onramps \
  --header 'Authorization: Bearer <token>'

{
  "status": true,
  "message": "Onramps 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": {
    "page": 1,
    "per_page": 50,
    "total": 137,
    "has_more": false,
    "request_id": "req_01HXYZ4K5ABCDEFGHJKLMNPQRS",
    "timestamp": "2026-05-14T15:43:55.732Z",
    "version": "1"
  }
}

Authorizations

Authorization

string

header

required

API key issued during merchant onboarding.

Query Parameters

customer_id

string

status

string

created_after

string

created_before

string

page

string

per_page

string

Response

Onramps fetched successfully

status

enum<boolean>

required

Available options:

true

Example:

true

message

string

required

Human-readable summary

Example:

"Onramps fetched successfully"

code

enum<string>

required

Available options:

ok

Example:

"ok"

data

object[]

required

Show child attributes