List offramps

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

{
  "status": true,
  "message": "Offramps fetched successfully",
  "code": "ok",
  "data": [
    {
      "id": "ofr_01KPBH887CCT3A53EW3F8R0VQG",
      "reference": "INV-2026-001",
      "status": "created",
      "retry_on_failure": false,
      "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"
      },
      "beneficiary": {
        "id": "ben_01KPBAP7WTDKQKW5B3R31VPNX4",
        "customer_id": "cust_01HXYZABC1234567890ABCDEFG",
        "name": "Alice Bank Beneficiary",
        "type": "fiat",
        "currency": "NGN",
        "details": {
          "country_code": "NG",
          "network": "bank",
          "account_number": "0039415616",
          "provider": {
            "id": "prov_01KPBAP7WTDKQKW5B3R31VPNX4",
            "name": "Access Bank",
            "code": "000014"
          },
          "account_name": "ALICE JOHNSON"
        },
        "metadata": {},
        "status": "pending",
        "created_at": "2026-04-16T16:14:08.000Z",
        "updated_at": "2026-04-16T16:14:08.000Z",
        "label": "Alice's salary account",
        "merchant_reference": "ref_01HXYZ4K5ABCDEFGHJKLMNPQRS"
      },
      "payment_instrument": {
        "id": "pay_01KPBH895W6PH3WY1D9KZH3M5D",
        "beneficiary_id": "ben_seed_alice_bank",
        "type": "bank_account",
        "country_code": "NG",
        "provider": {
          "id": "prov_01KPBAP7WTDKQKW5B3R31VPNX4",
          "name": "Access Bank",
          "code": "000014"
        },
        "account_name": "SEED BANK BENEFICIARY",
        "account_number": "0039415616"
      },
      "source_amount": "1.000000",
      "source_currency": "USDC",
      "destination_currency": "NGN",
      "rate": "0.000000",
      "rate_locked_until": "2026-04-16T16:46:07.000Z",
      "metadata": {},
      "created_at": "2026-04-16T16:16:12.000Z",
      "updated_at": "2026-04-16T16:16:13.000Z",
      "narration": "Payment for Invoice INV-2026-001",
      "destination_amount": "0.00",
      "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"
  }
}

Offramps

List offramps

List offramps, newest first.

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

Filter behavior

customer_id — restricts to offramps 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, 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/offramps?status=processing&customer_id=cust_seed_alice&page=1&per_page=50

GET

offramps

List offramps

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

{
  "status": true,
  "message": "Offramps fetched successfully",
  "code": "ok",
  "data": [
    {
      "id": "ofr_01KPBH887CCT3A53EW3F8R0VQG",
      "reference": "INV-2026-001",
      "status": "created",
      "retry_on_failure": false,
      "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"
      },
      "beneficiary": {
        "id": "ben_01KPBAP7WTDKQKW5B3R31VPNX4",
        "customer_id": "cust_01HXYZABC1234567890ABCDEFG",
        "name": "Alice Bank Beneficiary",
        "type": "fiat",
        "currency": "NGN",
        "details": {
          "country_code": "NG",
          "network": "bank",
          "account_number": "0039415616",
          "provider": {
            "id": "prov_01KPBAP7WTDKQKW5B3R31VPNX4",
            "name": "Access Bank",
            "code": "000014"
          },
          "account_name": "ALICE JOHNSON"
        },
        "metadata": {},
        "status": "pending",
        "created_at": "2026-04-16T16:14:08.000Z",
        "updated_at": "2026-04-16T16:14:08.000Z",
        "label": "Alice's salary account",
        "merchant_reference": "ref_01HXYZ4K5ABCDEFGHJKLMNPQRS"
      },
      "payment_instrument": {
        "id": "pay_01KPBH895W6PH3WY1D9KZH3M5D",
        "beneficiary_id": "ben_seed_alice_bank",
        "type": "bank_account",
        "country_code": "NG",
        "provider": {
          "id": "prov_01KPBAP7WTDKQKW5B3R31VPNX4",
          "name": "Access Bank",
          "code": "000014"
        },
        "account_name": "SEED BANK BENEFICIARY",
        "account_number": "0039415616"
      },
      "source_amount": "1.000000",
      "source_currency": "USDC",
      "destination_currency": "NGN",
      "rate": "0.000000",
      "rate_locked_until": "2026-04-16T16:46:07.000Z",
      "metadata": {},
      "created_at": "2026-04-16T16:16:12.000Z",
      "updated_at": "2026-04-16T16:16:13.000Z",
      "narration": "Payment for Invoice INV-2026-001",
      "destination_amount": "0.00",
      "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

Offramps fetched successfully

status

enum<boolean>

required

Available options:

true

Example:

true

message

string

required

Human-readable summary

Example:

"Offramps fetched successfully"

code

enum<string>

required

Available options:

ok

Example:

"ok"

data

object[]

required

Show child attributes