Create an offramp quote

curl --request POST \
  --url https://api.paystack.com/v1/offramps/quotes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "wallet_id": "<string>",
  "beneficiary_id": "<string>",
  "source_amount": "<string>",
  "narration": "<string>"
}
'

{
  "status": true,
  "message": "Quote created successfully",
  "code": "ok",
  "data": {
    "id": "quo_01KPBK123456789ABCDEFG",
    "operation": "onramp",
    "status": "active",
    "wallet_id": "wal_seed_alice_usdc",
    "customer_id": "cust_01HXYZABC1234567890ABCDEFG",
    "source_amount": "10000.00",
    "source_currency": "NGN",
    "destination_amount": "6.046600",
    "destination_currency": "USDC",
    "rate": "0.000605",
    "expires_at": "2026-04-22T02:30:00.000Z",
    "created_at": "2026-04-22T02:00:00.000Z",
    "updated_at": "2026-04-22T02:00:00.000Z",
    "reference": "INV-2026-001",
    "destination_wallet_id": "wal_seed_alice_ngn"
  },
  "meta": {
    "request_id": "req_01HXYZ4K5ABCDEFGHJKLMNPQRS",
    "timestamp": "2026-05-14T15:43:55.732Z",
    "version": "1"
  }
}

Quotes

Create an offramp quote

Creates an offramp quote — a short-lived, priced offer to convert the crypto held by the wallet identified by wallet_id into fiat paid out to beneficiary_id.

The wallet’s own currency (e.g. USDC) is the source; the beneficiary’s currency (e.g. NGN) is the destination. source_network is derived from a credential on the wallet; destination_network is the beneficiary’s payout rail. The beneficiary must belong to the same customer as the wallet. narration is optional and echoed back as the quote reference.

The quote is created with status: active and an expires_at in the near future.

You can optionally pass source_currency and destination_currency as consistency checks — if they do not match the wallet or beneficiary, we reject the request immediately.

POST

offramps

quotes

Create an offramp quote

curl --request POST \
  --url https://api.paystack.com/v1/offramps/quotes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "wallet_id": "<string>",
  "beneficiary_id": "<string>",
  "source_amount": "<string>",
  "narration": "<string>"
}
'

{
  "status": true,
  "message": "Quote created successfully",
  "code": "ok",
  "data": {
    "id": "quo_01KPBK123456789ABCDEFG",
    "operation": "onramp",
    "status": "active",
    "wallet_id": "wal_seed_alice_usdc",
    "customer_id": "cust_01HXYZABC1234567890ABCDEFG",
    "source_amount": "10000.00",
    "source_currency": "NGN",
    "destination_amount": "6.046600",
    "destination_currency": "USDC",
    "rate": "0.000605",
    "expires_at": "2026-04-22T02:30:00.000Z",
    "created_at": "2026-04-22T02:00:00.000Z",
    "updated_at": "2026-04-22T02:00:00.000Z",
    "reference": "INV-2026-001",
    "destination_wallet_id": "wal_seed_alice_ngn"
  },
  "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.

Headers

Idempotency-Key

string

Optional client-supplied key. Identical key + identical body within 24h replays the original response. Identical key + different body returns 409 idempotency_conflict. The hash is over raw bytes — clients retrying must send the byte-identical body; a re-serialised JSON payload will produce a different hash and a 409. Strongly recommended for retry-safe clients.

Pattern: ^[A-Za-z0-9_\-]{8,255}$

Body

application/json

CreateOfframpQuoteDto

wallet_id

string

required

Maximum string length: 64

beneficiary_id

string

required

Maximum string length: 64

source_amount

string

required

Pattern: ^\d+(\.\d+)?$

narration

string

Maximum string length: 128

Response

Quote created successfully

status

enum<boolean>

required

Available options:

true

Example:

true

message

string

required

Human-readable summary

Example:

"Quote created successfully"

code

enum<string>

required

Available options:

ok

Example:

"ok"

data

object

required

Show child attributes