Skip to main content
POST
/
v1
/
offramps
Execute an offramp
curl --request POST \
  --url https://api.paystack.com/v1/offramps \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "quote_id": "<string>",
  "reference": "<string>",
  "source_currency": "<string>",
  "destination_currency": "<string>",
  "metadata": {}
}
'
{
  "status": true,
  "message": "Offramp executed 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": {
    "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

ExecuteOfframpDto

​
quote_id
string
required
Maximum string length: 64
​
reference
string
required
Maximum string length: 128
​
source_currency
string
Pattern: ^[A-Z0-9]{2,8}$
​
destination_currency
string
Pattern: ^[A-Z0-9]{2,8}$
​
metadata
object

Response

Offramp executed successfully

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

true

​
message
string
required

Human-readable summary

Example:

"Offramp executed successfully"

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

"ok"

​
data
object
required
​
meta
object
required