Opens an offramp order that pays out to a bank account identified by bank code and account number. The account is confirmed with the provider first, so an unknown bank code or an account number that cannot be resolved is rejected before any order exists. When a bvn is given the order is credited to that end user — traced through their KYC record, or verified and registered if the BVN is new; without one the order is not attributed to any user. Provide either amount (token) or fiatAmount, not both. The returned address is where the tokens should be sent to fund the order.
Opens an order to convert a token into fiat and pay it into a bank account. This
is the explicit alternative to the bank account
address flow: instead of a standing address
that pays out whatever it receives, you state the amount up front, get back a
quote and a one-off funding address, and send the tokens there.Reach for this when the amount matters — you are quoting a user a specific naira
figure, or you need the payout tied to a single deposit rather than to an
address that anyone can pay at any time.
Naming the destination
The bank account is given as a bankCode (from Get
banks) plus an accountNumber. Before any order is
written, Paj confirms that pair with the payout rail. An account number the bank
cannot resolve is a 400 and leaves nothing behind — there is no half-created
order to clean up.The confirmed account holder’s name comes back on the response as accountName.
It is the bank’s answer, not an echo of your input, so it is worth showing to
the user as a last check before they part with funds.
Amount: token or fiat, never both
Send exactly one of:
amount — the quantity of mint you are selling. Paj prices it and tells
you the fiatAmount that will land.
fiatAmount — the payout you want the recipient to receive. Paj works
backwards and tells you the amount of mint to send.
Sending both is a 400; so is sending neither. mint is required either way,
and chain defaults to SOLANA.
Choosing the chain
Orders open on any supported chain: SOLANA, TON,
ETHEREUM, BASE, BSC, MONAD or ARC. This is the only way to pay out
from TON — a bank account’s standing
addresses cover Solana and the EVM chains,
but not TON.mint is the token’s address on that chain: a Solana mint, an ERC-20 contract,
or a TON jetton master ("TON" for Toncoin). It is checked against chain, so
an EVM contract sent without a chain — which defaults to SOLANA — is a
400. The chain’s settlement stablecoin —
USDC, or USDT on TON — pays out directly; anything else is priced at its USD
value when it lands.
The address that comes back is in that chain’s format, and is watched on that
chain alone. On the EVM chains the address is valid on all five networks, so a
user sending from a multi-chain wallet can easily pick the wrong one — make the
chain as prominent as the address when you show it.
Attributing the order to a user
customerId says who the order is for. It comes from verifying the person, and the order is refused unless they are verified at that moment. The bank account must also be in their name. bvn is deprecated in its favour, and you can’t send both.bvn is optional and identifies the end user the order belongs to. When you
send one, Paj traces it to that user through their KYC record; if the BVN is new
to Paj, it is verified with the identity provider and the user is registered from
the verified bio before the order is created. A BVN that fails verification is a
400.Omit it and the order is simply not attributed to any individual — it stays a
business-level order under your API key. The payout still works, but it goes out
without a payer name attached.
Funding the order
The response address is where the tokens go. Send amount of mint on
chain to that address and the order settles on its own — the deposit is the
instruction, and there is no second call to confirm it. Track progress by
status, which starts at INIT and ends at COMPLETED or ERROR.
Funding addresses are drawn from a shared pool and reused. Creating a new order
deprecates any earlier order sitting on the same address, so always send to the
address from the response you are acting on — never to one you cached from a
previous order.
Orders are not kept forever: an unfunded order is deleted 72 hours after it was
created. Treat the quote as good for that window, and re-create the order rather
than funding a stale one.
Getting told when it settles
Paj POSTs the order back to you on every status change, in the same shape as
this endpoint’s response. It goes to the order’s webhookURL if you set one,
and otherwise to the rampWebhookURL configured on your API key — so a key set
up once with Update your webhook URLs covers
every order without repeating the URL. With neither, you are polling.Deliveries are signed; see Webhook signatures.
Authorizations
x-api-key
string
header
required
Body
application/json
accountNumber
string
required
Account Number to receive funds
Example:
"679be2527f99f556d77b8cc2"
currency
object
required
Currency to receive funds
Example:
"NGN"
bankCode
string
required
Code of the bank that receives the payout
Example:
"000016"
mint
string
required
Mint address of the token being sold, on the given chain. On TON, a jetton master address or "TON" for Toncoin.
Example:
"EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v"
amount
number
Token amount (provide either amount or fiatAmount, not both)
Example:
100
fiatAmount
number
Fiat amount (provide either amount or fiatAmount, not both)
Example:
100
chain
object
Chain
Example:
"SOLANA"
webhookURL
string
Callback webhook url
Example:
"https://mydomain.com/webhook"
saveBeneficiary
boolean
Save beneficiary
Example:
true
description
string
Payment description
Example:
"Payment for order #123"
businessUSDCFee
number
default:0
Business fee
Example:
0.5
customerId
string
The customerId from KYC, for the person this order is for. The order is refused unless they are verified at that moment.
Example:
"cus_8f2a6c1d9e4b7f03a5c8d2e6b1f4a790"
bvn
string
deprecated
Deprecated: use customerId. BVN of the end user the order is created for. It is traced to that user's KYC record; if the BVN is not on file it is verified and the user is registered before the order is opened.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Paj API","colors":{"primary":"#0061ED","light":"#0061ED","dark":"#0061ED"},"favicon":"https://mintcdn.com/paj/sM84F14r9SEpFsV7/favicon.svg?fit=max\u0026auto=format\u0026n=sM84F14r9SEpFsV7\u0026q=85\u0026s=1ac0aa4dd2971336449606bf145b0b22","appearance":{"default":"light"},"navbar":{"primary":{"type":"button","label":"Get an API key","href":"https://developer.paj.cash/"}},"footer":{"socials":{"website":"https://paj.cash"}},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"paj","hasAudioNarration":false,"actualSubdomain":"paj","customDomains":["docs.paj.cash"],"gitSource":{"type":"github","owner":"paj-cash","repo":"main_backend","deployBranch":"main","contentDirectory":"docs-site","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6afc1f7e8fbc458f58e290a6","clientVersion":"0.0.4177","searchFilterCounts":[{"language":"default","tag":"API reference","count":22},{"language":"default","tag":"Documentation","count":11},{"language":"default","tag":"Concepts","count":8},{"language":"default","tag":"KYC","count":6},{"language":"default","tag":"Reference data","count":4},{"language":"default","tag":"Get started","count":3},{"language":"default","tag":"Payments","count":2},{"language":"default","tag":"Bank accounts","count":2},{"language":"default","tag":"Webhooks","count":2},{"language":"default","tag":"Offramp","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/create-offramp-order","slug":"/api-reference/create-offramp-order","pageMetadata":{"title":"Create an offramp order","openapi":"POST /pub/v2/offramp","description":"Opens an offramp order that pays out to a bank account identified by bank code and account number. The account is confirmed with the provider first, so an unknown bank code or an account number that cannot be resolved is rejected before any order exists. When a bvn is given the order is credited to that end user — traced through their KYC record, or verified and registered if the BVN is new; without one the order is not attributed to any user. Provide either amount (token) or fiatAmount, not both. The returned address is where the tokens should be sent to fund the order.","href":"/api-reference/create-offramp-order"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Opens an offramp order that pays out to a bank account identified by bank code and account number. The account is confirmed with the provider first, so an unknown bank code or an account number that cannot be resolved is rejected before any order exists. When a bvn is given the order is credited to that end user — traced through their KYC record, or verified and registered if the BVN is new; without one the order is not attributed to any user. Provide either amount (token) or fiatAmount, not both. The returned address is where the tokens should be sent to fund the order.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Heading,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Opens an order to convert a token into fiat and pay it into a bank account. This\nis the explicit alternative to the `,_jsx(_components.a,{href:`/concepts/bank-account-addresses`,children:`bank account\naddress`}),` flow: instead of a standing address\nthat pays out whatever it receives, you state the amount up front, get back a\nquote and a one-off funding address, and send the tokens there.`]}),`\n`,_jsx(_components.p,{children:`Reach for this when the amount matters — you are quoting a user a specific naira\nfigure, or you need the payout tied to a single deposit rather than to an\naddress that anyone can pay at any time.`}),`\n`,_jsx(Heading,{level:`2`,id:`naming-the-destination`,children:`Naming the destination`}),`\n`,_jsxs(_components.p,{children:[`The bank account is given as a `,_jsx(_components.code,{children:`bankCode`}),` (from `,_jsx(_components.a,{href:`/api-reference/get-banks`,children:`Get\nbanks`}),`) plus an `,_jsx(_components.code,{children:`accountNumber`}),`. Before any order is\nwritten, Paj confirms that pair with the payout rail. An account number the bank\ncannot resolve is a `,_jsx(_components.code,{children:`400`}),` and leaves nothing behind — there is no half-created\norder to clean up.`]}),`\n`,_jsxs(_components.p,{children:[`The confirmed account holder’s name comes back on the response as `,_jsx(_components.code,{children:`accountName`}),`.\nIt is the bank’s answer, not an echo of your input, so it is worth showing to\nthe user as a last check before they part with funds.`]}),`\n`,_jsx(Heading,{level:`2`,id:`amount-token-or-fiat-never-both`,children:`Amount: token or fiat, never both`}),`\n`,_jsxs(_components.p,{children:[`Send `,_jsx(_components.strong,{children:`exactly one`}),` of:`]}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:_jsx(_components.code,{children:`amount`})}),` — the quantity of `,_jsx(_components.code,{children:`mint`}),` you are selling. Paj prices it and tells\nyou the `,_jsx(_components.code,{children:`fiatAmount`}),` that will land.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:_jsx(_components.code,{children:`fiatAmount`})}),` — the payout you want the recipient to receive. Paj works\nbackwards and tells you the `,_jsx(_components.code,{children:`amount`}),` of `,_jsx(_components.code,{children:`mint`}),` to send.`]}),`\n`]}),`\n`,_jsxs(_components.p,{children:[`Sending both is a `,_jsx(_components.code,{children:`400`}),`; so is sending neither. `,_jsx(_components.code,{children:`mint`}),` is required either way,\nand `,_jsx(_components.code,{children:`chain`}),` defaults to `,_jsx(_components.code,{children:`SOLANA`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`choosing-the-chain`,children:`Choosing the chain`}),`\n`,_jsxs(_components.p,{children:[`Orders open on any `,_jsx(_components.a,{href:`/concepts/chains`,children:`supported chain`}),`: `,_jsx(_components.code,{children:`SOLANA`}),`, `,_jsx(_components.code,{children:`TON`}),`,\n`,_jsx(_components.code,{children:`ETHEREUM`}),`, `,_jsx(_components.code,{children:`BASE`}),`, `,_jsx(_components.code,{children:`BSC`}),`, `,_jsx(_components.code,{children:`MONAD`}),` or `,_jsx(_components.code,{children:`ARC`}),`. This is the only way to pay out\nfrom TON — a `,_jsx(_components.a,{href:`/concepts/bank-account-addresses`,children:`bank account’s standing\naddresses`}),` cover Solana and the EVM chains,\nbut not TON.`]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`mint`}),` is the token’s address on that chain: a Solana mint, an ERC-20 contract,\nor a TON jetton master (`,_jsx(_components.code,{children:`\"TON\"`}),` for Toncoin). It is checked against `,_jsx(_components.code,{children:`chain`}),`, so\nan EVM contract sent without a `,_jsx(_components.code,{children:`chain`}),` — which defaults to `,_jsx(_components.code,{children:`SOLANA`}),` — is a\n`,_jsx(_components.code,{children:`400`}),`. The chain’s settlement stablecoin —\nUSDC, or USDT on TON — pays out directly; anything else is priced at its USD\nvalue when it lands.`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`8`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`8`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"bankCode\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"000016\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"accountNumber\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"0025635480\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"currency\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"NGN\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"amount\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`20`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"chain\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"BASE\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"mint\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`The `,_jsx(_components.code,{children:`address`}),` that comes back is in that chain’s format, and is watched on that\nchain alone. On the EVM chains the address is valid on all five networks, so a\nuser sending from a multi-chain wallet can easily pick the wrong one — make the\nchain as prominent as the address when you show it.`]}),`\n`,_jsx(Heading,{level:`2`,id:`attributing-the-order-to-a-user`,children:`Attributing the order to a user`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`customerId`}),` says who the order is for. It comes from `,_jsx(_components.a,{href:`/concepts/kyc`,children:`verifying the person`}),`, and the order is refused unless they are verified at that moment. The bank account must also be in their name. `,_jsx(_components.code,{children:`bvn`}),` is deprecated in its favour, and you can’t send both.`]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`bvn`}),` is optional and identifies the end user the order belongs to. When you\nsend one, Paj traces it to that user through their KYC record; if the BVN is new\nto Paj, it is verified with the identity provider and the user is registered from\nthe verified bio before the order is created. A BVN that fails verification is a\n`,_jsx(_components.code,{children:`400`}),`.`]}),`\n`,_jsx(_components.p,{children:`Omit it and the order is simply not attributed to any individual — it stays a\nbusiness-level order under your API key. The payout still works, but it goes out\nwithout a payer name attached.`}),`\n`,_jsx(Heading,{level:`2`,id:`funding-the-order`,children:`Funding the order`}),`\n`,_jsxs(_components.p,{children:[`The response `,_jsx(_components.code,{children:`address`}),` is where the tokens go. Send `,_jsx(_components.code,{children:`amount`}),` of `,_jsx(_components.code,{children:`mint`}),` on\n`,_jsx(_components.code,{children:`chain`}),` to that address and the order settles on its own — the deposit is the\ninstruction, and there is no second call to confirm it. Track progress by\n`,_jsx(_components.code,{children:`status`}),`, which starts at `,_jsx(_components.code,{children:`INIT`}),` and ends at `,_jsx(_components.code,{children:`COMPLETED`}),` or `,_jsx(_components.code,{children:`ERROR`}),`.`]}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[`Funding addresses are drawn from a shared pool and reused. Creating a new order\ndeprecates any earlier order sitting on the same address, so always send to the\n`,_jsx(_components.code,{children:`address`}),` from the response you are acting on — never to one you cached from a\nprevious order.`]})}),`\n`,_jsx(_components.p,{children:`Orders are not kept forever: an unfunded order is deleted 72 hours after it was\ncreated. Treat the quote as good for that window, and re-create the order rather\nthan funding a stale one.`}),`\n`,_jsx(Heading,{level:`2`,id:`getting-told-when-it-settles`,children:`Getting told when it settles`}),`\n`,_jsxs(_components.p,{children:[`Paj `,_jsx(_components.code,{children:`POST`}),`s the order back to you on every status change, in the same shape as\nthis endpoint’s response. It goes to the order’s `,_jsx(_components.code,{children:`webhookURL`}),` if you set one,\nand otherwise to the `,_jsx(_components.code,{children:`rampWebhookURL`}),` configured on your API key — so a key set\nup once with `,_jsx(_components.a,{href:`/api-reference/update-webhooks`,children:`Update your webhook URLs`}),` covers\nevery order without repeating the URL. With neither, you are polling.`]}),`\n`,_jsxs(_components.p,{children:[`Deliveries are signed; see `,_jsx(_components.a,{href:`/concepts/webhook-signatures`,children:`Webhook signatures`}),`.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create an offramp order","openapi":"POST /pub/v2/offramp","description":"Opens an offramp order that pays out to a bank account identified by bank code and account number. The account is confirmed with the provider first, so an unknown bank code or an account number that cannot be resolved is rejected before any order exists. When a bvn is given the order is credited to that end user — traced through their KYC record, or verified and registered if the BVN is new; without one the order is not attributed to any user. Provide either amount (token) or fiatAmount, not both. The returned address is where the tokens should be sent to fund the order.","href":"/api-reference/create-offramp-order"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Naming the destination","slug":"naming-the-destination","depth":2,"children":[]},{"title":"Amount: token or fiat, never both","slug":"amount-token-or-fiat-never-both","depth":2,"children":[]},{"title":"Choosing the chain","slug":"choosing-the-chain","depth":2,"children":[]},{"title":"Attributing the order to a user","slug":"attributing-the-order-to-a-user","depth":2,"children":[]},{"title":"Funding the order","slug":"funding-the-order","depth":2,"children":[]},{"title":"Getting told when it settles","slug":"getting-told-when-it-settles","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Opens an offramp order that pays out to a bank account identified by bank code and account number. The account is confirmed with the provider first, so an unknown bank code or an account number that cannot be resolved is rejected before any order exists. When a bvn is given the order is credited to that end user — traced through their KYC record, or verified and registered if the BVN is new; without one the order is not attributed to any user. Provide either amount (token) or fiatAmount, not both. The returned address is where the tokens should be sent to fund the order.","operationId":"PubV2Controller_createOfframpOrder","parameters":[],"requestBody":"dd145324-1d04-4510-95e1-090f94a115f7","responses":{"201":"37d34a24-b73c-4578-bc74-b0a9125ed99d","400":"ad898424-b271-4f1c-b9a9-3673bad02224","401":"0338b13f-cd5d-4b58-938c-ecd35f016261","404":"ba526054-5270-421a-9516-0b355452246a"},"security":["31fe43ec-f6bf-4595-a1b9-ac8581d3310c"],"summary":"Create an offramp order","tags":["Pub V2"],"method":"post","type":"path","servers":["48304386-2186-49fe-ad69-f0ee560490f3"],"path":"/pub/v2/offramp","baseUrlOptions":["https://api.paj.cash"],"title":"Create an offramp order","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"accountNumber":{"type":"string","description":"Account Number to receive funds","example":"679be2527f99f556d77b8cc2","isRequired":true,"uniqueKey":"accountNumber","typeLabel":"string"},"currency":{"type":"object","description":"Currency to receive funds","example":"NGN","isRequired":true,"uniqueKey":"currency","typeLabel":"object"},"bankCode":{"type":"string","description":"Code of the bank that receives the payout","example":"000016","isRequired":true,"uniqueKey":"bankCode","typeLabel":"string"},"mint":{"type":"string","description":"Mint address of the token being sold, on the given chain. On TON, a jetton master address or \"TON\" for Toncoin.","example":"EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v","isRequired":true,"uniqueKey":"mint","typeLabel":"string"},"amount":{"type":"number","description":"Token amount (provide either amount or fiatAmount, not both)","example":100,"uniqueKey":"amount","typeLabel":"number"},"fiatAmount":{"type":"number","description":"Fiat amount (provide either amount or fiatAmount, not both)","example":100,"uniqueKey":"fiatAmount","typeLabel":"number"},"chain":{"type":"object","description":"Chain","example":"SOLANA","default":"SOLANA","uniqueKey":"chain","typeLabel":"object"},"webhookURL":{"type":"string","description":"Callback webhook url","example":"https://mydomain.com/webhook","uniqueKey":"webhookURL","typeLabel":"string"},"saveBeneficiary":{"type":"boolean","description":"Save beneficiary","example":true,"uniqueKey":"saveBeneficiary","typeLabel":"boolean"},"description":{"type":"string","description":"Payment description","example":"Payment for order #123","uniqueKey":"description","typeLabel":"string"},"businessUSDCFee":{"type":"number","description":"Business fee","example":0.5,"default":0,"uniqueKey":"businessUSDCFee","typeLabel":"number"},"customerId":{"type":"string","description":"The customerId from KYC, for the person this order is for. The order is refused unless they are verified at that moment.","example":"cus_8f2a6c1d9e4b7f03a5c8d2e6b1f4a790","uniqueKey":"customerId","typeLabel":"string"},"bvn":{"type":"string","description":"Deprecated: use customerId. BVN of the end user the order is created for. It is traced to that user's KYC record; if the BVN is not on file it is verified and the user is registered before the order is opened.","example":"22222222222","deprecated":true,"uniqueKey":"bvn","typeLabel":"string"}},"required":["accountNumber","currency","bankCode","mint"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"accountNumber":"679be2527f99f556d77b8cc2","currency":"NGN","bankCode":"000016","mint":"EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v","amount":100,"fiatAmount":100,"chain":"SOLANA","webhookURL":"https://mydomain.com/webhook","saveBeneficiary":true,"description":"Payment for order #123","businessUSDCFee":0.5,"customerId":"cus_8f2a6c1d9e4b7f03a5c8d2e6b1f4a790","bvn":"22222222222"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"37d34a24-b73c-4578-bc74-b0a9125ed99d":{"description":"The created offramp order","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Transaction Id","example":"679be2527f99f556d77b8cc2","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"address":{"type":"string","description":"Address","example":"4KSLE7EU1P7PQ8Rc4hdb2ZKq2JmWHD8UXJp7guEdyT9j","isRequired":true,"uniqueKey":"address","typeLabel":"string"},"signature":{"type":"string","description":"Transaction Signature","example":"2oLx7XrXP7Df9dZca1difJ91ZFmA44EEadNqrZTecta6ugcX8BAETbpvKQs54r58fmJTQVLzUSuzvRBFwS1GfJLo","isRequired":true,"uniqueKey":"signature","typeLabel":"string"},"mint":{"type":"string","description":"Mint Address","example":"So11111111111111111111111111111111111111112","isRequired":true,"uniqueKey":"mint","typeLabel":"string"},"currency":{"type":"object","description":"Currency","example":"NGN","isRequired":true,"uniqueKey":"currency","typeLabel":"object"},"amount":{"type":"number","description":"Mint Amount","example":100000,"isRequired":true,"uniqueKey":"amount","typeLabel":"number"},"usdcAmount":{"type":"number","description":"Usdc Amount","example":100,"isRequired":true,"uniqueKey":"usdcAmount","typeLabel":"number"},"fiatAmount":{"type":"number","description":"Fiat Amount","example":100,"isRequired":true,"uniqueKey":"fiatAmount","typeLabel":"number"},"sender":{"type":"string","description":"Wallet Public Key","example":"4KSLE7EU1P7PQ8Rc4hdb2ZKq2JmWHD8UXJp7guEdyT9j","isRequired":true,"uniqueKey":"sender","typeLabel":"string"},"recipient":{"type":"string","description":"Recipient Public Key","example":"4KSLE7EU1P7PQ8Rc4hdb2ZKq2JmWHD8UXJp7guEdyT9j","isRequired":true,"uniqueKey":"recipient","typeLabel":"string"},"rate":{"type":"number","description":"Rate of currency to usdc","example":9,"isRequired":true,"uniqueKey":"rate","typeLabel":"number"},"status":{"type":"object","description":"Transaction Status","example":"PENDDING","isRequired":true,"uniqueKey":"status","typeLabel":"object"},"transactionType":{"type":"object","description":"Transaction Type","example":"OFF_RAMP","isRequired":true,"uniqueKey":"transactionType","typeLabel":"object"},"createdAt":{"format":"date-time","type":"string","description":"Transaction creation date","example":"2026-11-16T22:08:05.608Z","isRequired":true,"uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"accountNumber":{"type":"string","description":"Account Number (for onramp transactions)","example":"0025635480","isRequired":true,"uniqueKey":"accountNumber","typeLabel":"string"},"accountName":{"type":"string","description":"Account Name (for onramp transactions)","example":"Paj Inc.","isRequired":true,"uniqueKey":"accountName","typeLabel":"string"},"bank":{"type":"string","description":"Bank Name (for onramp transactions)","example":"First Bank","isRequired":true,"uniqueKey":"bank","typeLabel":"string"},"fee":{"type":"number","description":"Transaction fee in usdc","example":0.2,"isRequired":true,"uniqueKey":"fee","typeLabel":"number"},"chain":{"type":"object","description":"Chain","example":"SOLANA","isRequired":true,"uniqueKey":"chain","typeLabel":"object"}},"required":["id","address","signature","mint","currency","amount","usdcAmount","fiatAmount","sender","recipient","rate","status","transactionType","createdAt","accountNumber","accountName","bank","fee","chain"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"679be2527f99f556d77b8cc2","address":"4KSLE7EU1P7PQ8Rc4hdb2ZKq2JmWHD8UXJp7guEdyT9j","signature":"2oLx7XrXP7Df9dZca1difJ91ZFmA44EEadNqrZTecta6ugcX8BAETbpvKQs54r58fmJTQVLzUSuzvRBFwS1GfJLo","mint":"So11111111111111111111111111111111111111112","currency":"NGN","amount":100000,"usdcAmount":100,"fiatAmount":100,"sender":"4KSLE7EU1P7PQ8Rc4hdb2ZKq2JmWHD8UXJp7guEdyT9j","recipient":"4KSLE7EU1P7PQ8Rc4hdb2ZKq2JmWHD8UXJp7guEdyT9j","rate":9,"status":"PENDDING","transactionType":"OFF_RAMP","createdAt":"2026-11-16T22:08:05.608Z","accountNumber":"0025635480","accountName":"Paj Inc.","bank":"First Bank","fee":0.2,"chain":"SOLANA"}}},"exampleType":"generated"}},"exampleType":"generated"},"ad898424-b271-4f1c-b9a9-3673bad02224":{"description":"The bvn could not be verified, the account number could not be confirmed, or the order failed validation","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"0338b13f-cd5d-4b58-938c-ecd35f016261":{"description":"Missing or invalid API key (x-api-key header)","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"ba526054-5270-421a-9516-0b355452246a":{"description":"Unknown bank code","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"31fe43ec-f6bf-4595-a1b9-ac8581d3310c":{"x-api-key":{"type":"apiKey","in":"header","name":"x-api-key","scopes":[],"schemeName":"x-api-key"}}},"servers":{"48304386-2186-49fe-ad69-f0ee560490f3":{"url":"https://api.paj.cash","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-api-key","scopes":[],"schemeName":"x-api-key"},"schema":{"title":"x-api-key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"x-api-key","name":"x-api-key"}],"title":"x-api-key"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"paj","siteName":"Paj API","title":"Create an offramp order - Paj API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-10T13:44:11.859Z","originalFileLocation":"api-reference/create-offramp-order.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Opens an offramp order that pays out to a bank account identified by bank code and account number. The account is confirmed with the provider first, so an unknown bank code or an account number that cannot be resolved is rejected before any order exists. When a bvn is given the order is credited to that end user — traced through their KYC record, or verified and registered if the BVN is new; without one the order is not attributed to any user. Provide either amount (token) or fiatAmount, not both. The returned address is where the tokens should be sent to fund the order.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Paj API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/paj/DFLkHVdVXYAdgkSY/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/paj/DFLkHVdVXYAdgkSY/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/paj/DFLkHVdVXYAdgkSY/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/paj/DFLkHVdVXYAdgkSY/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/paj/DFLkHVdVXYAdgkSY/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/paj/DFLkHVdVXYAdgkSY/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/paj/DFLkHVdVXYAdgkSY/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/paj/DFLkHVdVXYAdgkSY/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/paj/DFLkHVdVXYAdgkSY/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create an offramp order - Paj API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Opens an offramp order that pays out to a bank account identified by bank code and account number. The account is confirmed with the provider first, so an unknown bank code or an account number that cannot be resolved is rejected before any order exists. When a bvn is given the order is credited to that end user — traced through their KYC record, or verified and registered if the BVN is new; without one the order is not attributed to any user. Provide either amount (token) or fiatAmount, not both. The returned address is where the tokens should be sent to fund the order.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Paj API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.paj.cash/api-reference/create-offramp-order\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://paj.mintlify.site/_mintlify/api/og/v2?division=Offramp\u0026amp;title=Create+an+offramp+order\u0026amp;description=Opens+an+offramp+order+that+pays+out+to+a+bank+account+identified+by+bank+code+and+account+number.+The+account+is+confirmed+with+the+provider+first%2C+so+an+unkno\u0026amp;theme=07e22cd0d20fc7185c62ff58\u0026amp;signature=3080d516738dcd7c53ca52410e28ff0eb0591b00be040f988b33ed57bb5dacae\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create an offramp order - Paj API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Opens an offramp order that pays out to a bank account identified by bank code and account number. The account is confirmed with the provider first, so an unknown bank code or an account number that cannot be resolved is rejected before any order exists. When a bvn is given the order is credited to that end user — traced through their KYC record, or verified and registered if the BVN is new; without one the order is not attributed to any user. Provide either amount (token) or fiatAmount, not both. The returned address is where the tokens should be sent to fund the order.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://paj.mintlify.site/_mintlify/api/og/v2?division=Offramp\u0026amp;title=Create+an+offramp+order\u0026amp;description=Opens+an+offramp+order+that+pays+out+to+a+bank+account+identified+by+bank+code+and+account+number.+The+account+is+confirmed+with+the+provider+first%2C+so+an+unkno\u0026amp;theme=07e22cd0d20fc7185c62ff58\u0026amp;signature=3080d516738dcd7c53ca52410e28ff0eb0591b00be040f988b33ed57bb5dacae\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/paj/DFLkHVdVXYAdgkSY/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Paj API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0061ED\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.paj.cash/api-reference/create-offramp-order\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/create-offramp-order.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.paj.cash/#organization\",\"name\":\"Paj API\",\"url\":\"https://docs.paj.cash\"},{\"@type\":\"WebSite\",\"@id\":\"https://docs.paj.cash#website\",\"name\":\"Paj API\",\"url\":\"https://docs.paj.cash\",\"publisher\":{\"@id\":\"https://docs.paj.cash/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.paj.cash/api-reference/create-offramp-order#webpage\",\"url\":\"https://docs.paj.cash/api-reference/create-offramp-order\",\"name\":\"Create an offramp order\",\"description\":\"Opens an offramp order that pays out to a bank account identified by bank code and account number. The account is confirmed with the provider first, so an unknown bank code or an account number that cannot be resolved is rejected before any order exists. When a bvn is given the order is credited to that end user — traced through their KYC record, or verified and registered if the BVN is new; without one the order is not attributed to any user. Provide either amount (token) or fiatAmount, not both. The returned address is where the tokens should be sent to fund the order.\",\"dateModified\":\"2026-11-10T13:44:11.859Z\",\"isPartOf\":{\"@id\":\"https://docs.paj.cash#website\"},\"breadcrumb\":{\"@id\":\"https://docs.paj.cash/api-reference/create-offramp-order#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.paj.cash/api-reference/create-offramp-order#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Paj API\",\"item\":\"https://docs.paj.cash\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create an offramp order\",\"item\":\"https://docs.paj.cash/api-reference/create-offramp-order\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.paj.cash/api-reference/create-offramp-order#apireference\",\"headline\":\"Create an offramp order\",\"name\":\"Create an offramp order\",\"description\":\"Opens an offramp order that pays out to a bank account identified by bank code and account number. The account is confirmed with the provider first, so an unknown bank code or an account number that cannot be resolved is rejected before any order exists. When a bvn is given the order is credited to that end user — traced through their KYC record, or verified and registered if the BVN is new; without one the order is not attributed to any user. Provide either amount (token) or fiatAmount, not both. The returned address is where the tokens should be sent to fund the order.\",\"url\":\"https://docs.paj.cash/api-reference/create-offramp-order\",\"mainEntityOfPage\":{\"@id\":\"https://docs.paj.cash/api-reference/create-offramp-order#webpage\"},\"dateModified\":\"2026-11-10T13:44:11.859Z\",\"publisher\":{\"@id\":\"https://docs.paj.cash/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.paj.cash#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Paj API\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Paj API\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/create-offramp-order.md","siteName":"Paj API","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"API reference","groups":[{"group":"KYC","pages":[{"title":"Get the KYC consent text","openapi":"GET /pub/v2/kyc/consent","href":"/api-reference/get-kyc-consent"},{"title":"Start verifying a person","openapi":"POST /pub/v2/kyc/sessions","href":"/api-reference/create-kyc-session"},{"title":"Confirm the code","openapi":"POST /pub/v2/kyc/sessions/{id}/verify-otp","href":"/api-reference/verify-kyc-otp"},{"title":"Send a new code","openapi":"POST /pub/v2/kyc/sessions/{id}/resend-otp","href":"/api-reference/resend-kyc-otp"},{"title":"Get a KYC session","openapi":"GET /pub/v2/kyc/sessions/{id}","href":"/api-reference/get-kyc-session"},{"title":"Get a customer","openapi":"GET /pub/v2/customers/{customerId}","href":"/api-reference/get-customer"}]},{"group":"Bank accounts","pages":[{"title":"Register a bank account","openapi":"POST /pub/v2/bank-account","href":"/api-reference/register-bank-account"},{"title":"Search for a bank account","openapi":"GET /pub/v2/bank-account","href":"/api-reference/search-bank-account"}]},{"group":"Deposit tracking","pages":[{"title":"Track a deposit","href":"/api-reference/track-deposits"}]},{"group":"Banks","pages":[{"title":"Get banks","openapi":"GET /pub/v2/bank","href":"/api-reference/get-banks"}]},{"group":"Onramp","pages":[{"title":"Create an onramp order","openapi":"POST /pub/v2/onramp","description":"Opens an onramp order for the API key’s business and returns the virtual bank account the end user pays into. Provide either amount (token) or fiatAmount, not both. When a bvn is given the order is credited to that end user — traced through their KYC record, or verified and registered if the BVN is new; without one the order is not attributed to any user. Once the deposit is confirmed the token is delivered to recipient on the given chain, and every status change is posted to webhookURL.","href":"/api-reference/create-onramp-order"}]},{"group":"Offramp","pages":[{"title":"Create an offramp order","openapi":"POST /pub/v2/offramp","href":"/api-reference/create-offramp-order"}]},{"group":"Transactions","pages":[{"title":"Get a transaction","openapi":"GET /pub/v2/transaction/{id}","description":"Looks up an onramp or offramp order by the id returned when it was created, at any stage from INIT through to COMPLETED or ERROR. Only orders belonging to the API key’s business are found; any other id returns 404.","href":"/api-reference/get-transaction"}]},{"group":"Payments","pages":[{"title":"Create a payment","openapi":"POST /pub/v2/payment","href":"/api-reference/create-payment"},{"title":"Track a payment","href":"/api-reference/track-payments"}]},{"group":"Rates","pages":[{"title":"Get rates","openapi":"GET /pub/v2/rate","href":"/api-reference/get-rates"}]},{"group":"Reference data","pages":[{"title":"Get chains","openapi":"GET /pub/v2/chains","href":"/api-reference/get-chains"},{"title":"Get currencies","openapi":"GET /pub/v2/currencies","href":"/api-reference/get-currencies"},{"title":"List tokens on a chain","openapi":"GET /pub/v2/tokens","href":"/api-reference/get-tokens"},{"title":"Get a token","openapi":"GET /pub/v2/tokens/{address}","href":"/api-reference/get-token"}]},{"group":"Webhooks","pages":[{"title":"Update your webhook URLs","openapi":"PATCH /pub/v2/webhook","href":"/api-reference/update-webhooks"},{"title":"Test your webhook","openapi":"POST /pub/v2/webhook/test","href":"/api-reference/test-webhook"}]}]}]},"basePath":"","title":"Create an offramp order - Paj API","deploymentId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","buildId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-jJHA3WSo.js","utils-DbZn3Mjn.js","cloneDeep-CnBnaSyy.js","_Uint8Array-CMQtTgBR.js","isObject-FP1Yky1u.js","utils-Bl2DvzOJ.js","addUniqueKeysToSchema-BwOLo9p1.js","snippetPresets-BBiPpKa-.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-C0px4Tml.js","isEqual-zAyttAAO.js","usePlaygroundInputsStore-Dell6dGw.js","shallow-0VKqkSqN.js","getApiPlaygroundDisplay-CP_ctPEB.js","CodeSnippet-5L35ic0s.js","CodeSnippets-DOXbNhJw.js","Page-DRLI_2Ue.js","getPastedJson-VhzT9m2P.js","icon-CD8_AtCO.js","MethodPill-DGgOMftG.js","DuplicateIcon-DZ6A_EtN.js","createIcon-DUl4oM5f.js","DynamicMarkdown-BGHukeRM.js","SectionHeading-ChrEUs8u.js","axios-vUo_bRtp.js","Markdown-Dj-na-_-.js","dist-C5gjFYHe.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-DEBW87tT.js"]}