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.
Opens an order to convert fiat into a token. Paj hands you a virtual bank
account, your user pays naira into it, and the token is delivered to the wallet
you named. It is the mirror image of Create an offramp
order, and the two share a shape: state
the amount up front, get back somewhere to send funds, and let the deposit do
the rest.
Amount: token or fiat, never both
Send exactly one of:
fiatAmount — what your user will pay, in currency. Paj works out how
much token that buys.
amount — how much of mint your user should end up with. Paj works
backwards to the fiat figure they must pay.
Sending both is a 400; so is sending neither. recipient, mint and chain
are required either way.
Choosing the chain
chain is where the token is delivered, and can be any supported
chain: SOLANA, TON, ETHEREUM, BASE, BSC, MONAD or
ARC. recipient is a wallet on that chain and mint is the token’s address on
it.Buying the chain’s settlement stablecoin (USDC, or USDT on TON) is a direct
transfer. Any other token is swapped on-chain from that stablecoin, with the
output delivered straight to recipient in the same step, so what arrives can
differ slightly from the quote by the swap’s slippage.
On TON, mint is "TON" for Toncoin or a jetton master address for
anything else. Any spelling of a TON address — EQ…, UQ… or raw 0:… — is
accepted for both mint and recipient.recipient and mint must be addresses in the format of chain — a Solana
address on an EVM order, or the reverse, is a 400.
An EVM address is valid on all five EVM chains, so the format alone cannot
catch a user who gave you their wallet for the wrong EVM network. The token is
sent on chain; confirm the wallet can receive there.
The account to pay
Four fields on the response describe where the money goes:
Field
What it is
accountNumber
A virtual account opened for this order alone
bank
The bank that account sits with
fiatAmount
The exact amount to transfer, in major units
accountName
The account holder, with the amount embedded
accountName is worth a note: it comes back looking like
Paj Inc.(Pay NGN 1,500.00). The amount is baked into the name deliberately, so
the figure is visible inside the user’s own banking app while they are typing
the transfer. Render it as-is, but drive your own UI from fiatAmount — parsing
the name is fragile.
The virtual account is per-order and the amount is expected to match. Do not
cache an account number and reuse it for a later order, and do not let a user
send a different figure than the one quoted.
Charging your own fee
businessUSDCFee is your markup, in USDC, and it is added on top rather
than taken out of the middle. If your user is buying $10 of a token and you set
a fee of `0.5`, they are billed the naira equivalent of $10.50 and still receive
the full $10 of token. The fee comes back on the response as fee. Despite the
name, it is counted in the chain’s settlement stablecoin, which on TON is USDT.Leave it off and you charge nothing beyond the rate, which already includes the
spread configured for your business — see Rates.
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. 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 stays a business-level order under your API key. If you
only need your own identifier carried through, userExternalId is a free-text
field Paj stores and echoes back without interpreting.
First-time recipients on Solana
If recipient has never held mint on Solana, a token account has to be created
for it before the token can land, and that costs rent. Paj charges it to the
order. Nothing is required from you — but a first purchase can cost fractionally
more than a repeat one for the same user, which is worth knowing before a
support ticket asks why.
Following the order
status starts at INIT and moves to PROCESSING when the deposit is
confirmed, then COMPLETED once the token has been delivered. ERROR is
terminal. Paj POSTs the whole order back to you at every one of those
transitions, 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 on
your API key; with neither, you are polling.Unpaid orders are not kept forever: an order is deleted 72 hours after it was
created. Treat the quote as good for that window and open a fresh order rather
than pointing a user at a stale account.
Authorizations
x-api-key
string
header
required
Body
application/json
currency
object
required
Local currency user wish to use
Example:
"NGN"
recipient
string
required
User wallet address
Example:
"4C8XFXBPG1Dm2eBs68oixjsVEzjxz5pwTDrLCR17ZRGz"
mint
string
required
Expected token mint address. On TON, a jetton master address or "TON" for Toncoin.
Example:
"EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v"
chain
object
required
Wallet Chain
Example:
"SOLANA"
fiatAmount
number
Amount user should doposite; in local currency. Mutually exclusive with amount.
Example:
100
amount
number
Amount of token user expected to receive. Mutually exclusive with fiatAmount.
webhookURL
string
Webhook URL to receive order status updates
Example:
"https://example.com/webhook"
userExternalId
string
User external id
Example:
"user-123"
businessUSDCFee
number
default:0
Business fee in USDC deducted from the token amount sent to the user
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.
Example:
"22222222222"
Response
The created onramp order. accountNumber, accountName and bank are the account to pay; the order stays in INIT until the deposit lands.
{"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-onramp-order","slug":"/api-reference/create-onramp-order","pageMetadata":{"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"},"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 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.\"\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`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,CodeGroup,Heading,Table,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!CodeGroup)_missingMdxReference(`CodeGroup`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Opens an order to convert fiat into a token. Paj hands you a virtual bank\naccount, your user pays naira into it, and the token is delivered to the wallet\nyou named. It is the mirror image of `,_jsx(_components.a,{href:`/api-reference/create-offramp-order`,children:`Create an offramp\norder`}),`, and the two share a shape: state\nthe amount up front, get back somewhere to send funds, and let the deposit do\nthe rest.`]}),`\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:`fiatAmount`})}),` — what your user will pay, in `,_jsx(_components.code,{children:`currency`}),`. Paj works out how\nmuch token that buys.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:_jsx(_components.code,{children:`amount`})}),` — how much of `,_jsx(_components.code,{children:`mint`}),` your user should end up with. Paj works\nbackwards to the fiat figure they must pay.`]}),`\n`]}),`\n`,_jsxs(_components.p,{children:[`Sending both is a `,_jsx(_components.code,{children:`400`}),`; so is sending neither. `,_jsx(_components.code,{children:`recipient`}),`, `,_jsx(_components.code,{children:`mint`}),` and `,_jsx(_components.code,{children:`chain`}),`\nare required either way.`]}),`\n`,_jsx(Heading,{level:`2`,id:`choosing-the-chain`,children:`Choosing the chain`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`chain`}),` is where the token is delivered, and can be any `,_jsx(_components.a,{href:`/concepts/chains`,children:`supported\nchain`}),`: `,_jsx(_components.code,{children:`SOLANA`}),`, `,_jsx(_components.code,{children:`TON`}),`, `,_jsx(_components.code,{children:`ETHEREUM`}),`, `,_jsx(_components.code,{children:`BASE`}),`, `,_jsx(_components.code,{children:`BSC`}),`, `,_jsx(_components.code,{children:`MONAD`}),` or\n`,_jsx(_components.code,{children:`ARC`}),`. `,_jsx(_components.code,{children:`recipient`}),` is a wallet on that chain and `,_jsx(_components.code,{children:`mint`}),` is the token’s address on\nit.`]}),`\n`,_jsxs(_components.p,{children:[`Buying the chain’s settlement stablecoin (USDC, or USDT on TON) is a direct\ntransfer. Any other token is swapped on-chain from that stablecoin, with the\noutput delivered straight to `,_jsx(_components.code,{children:`recipient`}),` in the same step, so what arrives can\ndiffer slightly from the quote by the swap’s slippage.`]}),`\n`,_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`Solana`,numberOfLines:`7`,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:`7`,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:` \"fiatAmount\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`15000`}),_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:` \"chain\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"SOLANA\"`}),_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:`\"EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v\"`}),_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:` \"recipient\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"4C8XFXBPG1Dm2eBs68oixjsVEzjxz5pwTDrLCR17ZRGz\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),_jsx(CodeBlock,{filename:`Arc`,numberOfLines:`7`,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:`7`,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:` \"fiatAmount\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`15000`}),_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:` \"chain\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"ARC\"`}),_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:`\"0x3600000000000000000000000000000000000000\"`}),_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:` \"recipient\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"0x2B5AD5c4795c026514f8317c7a215E218DcCD6cF\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),_jsx(CodeBlock,{filename:`TON (Toncoin)`,numberOfLines:`7`,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:`7`,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:` \"fiatAmount\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`15000`}),_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:` \"chain\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"TON\"`}),_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:`\"TON\"`}),_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:` \"recipient\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"UQBvW8Z5huBkMJYdnfAEM5JqTNkuWX3diqYENkWsIL0XgHwB\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})})]}),`\n`,_jsxs(_components.p,{children:[`On TON, `,_jsx(_components.code,{children:`mint`}),` is `,_jsx(_components.code,{children:`\"TON\"`}),` for Toncoin or a jetton `,_jsx(_components.strong,{children:`master`}),` address for\nanything else. Any spelling of a TON address — `,_jsx(_components.code,{children:`EQ…`}),`, `,_jsx(_components.code,{children:`UQ…`}),` or raw `,_jsx(_components.code,{children:`0:…`}),` — is\naccepted for both `,_jsx(_components.code,{children:`mint`}),` and `,_jsx(_components.code,{children:`recipient`}),`.`]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`recipient`}),` and `,_jsx(_components.code,{children:`mint`}),` must be addresses in the format of `,_jsx(_components.code,{children:`chain`}),` — a Solana\naddress on an EVM order, or the reverse, is a `,_jsx(_components.code,{children:`400`}),`.`]}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[`An EVM address is valid on all five EVM chains, so the format alone cannot\ncatch a user who gave you their wallet for the wrong EVM network. The token is\nsent on `,_jsx(_components.code,{children:`chain`}),`; confirm the wallet can receive there.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`the-account-to-pay`,children:`The account to pay`}),`\n`,_jsx(_components.p,{children:`Four fields on the response describe where the money goes:`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Field`}),_jsx(_components.th,{children:`What it is`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`accountNumber`})}),_jsx(_components.td,{children:`A virtual account opened for this order alone`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`bank`})}),_jsx(_components.td,{children:`The bank that account sits with`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`fiatAmount`})}),_jsx(_components.td,{children:`The exact amount to transfer, in major units`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`accountName`})}),_jsx(_components.td,{children:`The account holder, with the amount embedded`})]})]})]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`accountName`}),` is worth a note: it comes back looking like\n`,_jsx(_components.code,{children:`Paj Inc.(Pay NGN 1,500.00)`}),`. The amount is baked into the name deliberately, so\nthe figure is visible inside the user’s own banking app while they are typing\nthe transfer. Render it as-is, but drive your own UI from `,_jsx(_components.code,{children:`fiatAmount`}),` — parsing\nthe name is fragile.`]}),`\n`,_jsx(Warning,{children:_jsx(_components.p,{children:`The virtual account is per-order and the amount is expected to match. Do not\ncache an account number and reuse it for a later order, and do not let a user\nsend a different figure than the one quoted.`})}),`\n`,_jsx(Heading,{level:`2`,id:`charging-your-own-fee`,children:`Charging your own fee`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`businessUSDCFee`}),` is your markup, in USDC, and it is added `,_jsx(_components.strong,{children:`on top`}),` rather\nthan taken out of the middle. If your user is buying `,\"$10 of a token and you set\\na fee of `0.5`, they are billed the naira equivalent of $\",`10.50 and still receive\nthe full $10 of token. The fee comes back on the response as `,_jsx(_components.code,{children:`fee`}),`. Despite the\nname, it is counted in the chain’s settlement stablecoin, which on TON is USDT.`]}),`\n`,_jsxs(_components.p,{children:[`Leave it off and you charge nothing beyond the rate, which already includes the\nspread configured for your business — see `,_jsx(_components.a,{href:`/concepts/rates`,children:`Rates`}),`.`]}),`\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. `,_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`,_jsxs(_components.p,{children:[`Omit it and the order stays a business-level order under your API key. If you\nonly need your own identifier carried through, `,_jsx(_components.code,{children:`userExternalId`}),` is a free-text\nfield Paj stores and echoes back without interpreting.`]}),`\n`,_jsx(Heading,{level:`2`,id:`first-time-recipients-on-solana`,children:`First-time recipients on Solana`}),`\n`,_jsxs(_components.p,{children:[`If `,_jsx(_components.code,{children:`recipient`}),` has never held `,_jsx(_components.code,{children:`mint`}),` on Solana, a token account has to be created\nfor it before the token can land, and that costs rent. Paj charges it to the\norder. Nothing is required from you — but a first purchase can cost fractionally\nmore than a repeat one for the same user, which is worth knowing before a\nsupport ticket asks why.`]}),`\n`,_jsx(Heading,{level:`2`,id:`following-the-order`,children:`Following the order`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`status`}),` starts at `,_jsx(_components.code,{children:`INIT`}),` and moves to `,_jsx(_components.code,{children:`PROCESSING`}),` when the deposit is\nconfirmed, then `,_jsx(_components.code,{children:`COMPLETED`}),` once the token has been delivered. `,_jsx(_components.code,{children:`ERROR`}),` is\nterminal. Paj `,_jsx(_components.code,{children:`POST`}),`s the whole order back to you at every one of those\ntransitions, in the same shape as this endpoint’s response. It goes to the\norder’s `,_jsx(_components.code,{children:`webhookURL`}),` if you set one, and otherwise to the `,_jsx(_components.code,{children:`rampWebhookURL`}),` on\nyour API key; with neither, you are polling.`]}),`\n`,_jsx(_components.p,{children:`Unpaid orders are not kept forever: an order is deleted 72 hours after it was\ncreated. Treat the quote as good for that window and open a fresh order rather\nthan pointing a user at a stale account.`})]})}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 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"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"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":"The account to pay","slug":"the-account-to-pay","depth":2,"children":[]},{"title":"Charging your own fee","slug":"charging-your-own-fee","depth":2,"children":[]},{"title":"Attributing the order to a user","slug":"attributing-the-order-to-a-user","depth":2,"children":[]},{"title":"First-time recipients on Solana","slug":"first-time-recipients-on-solana","depth":2,"children":[]},{"title":"Following the order","slug":"following-the-order","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"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.","operationId":"PubV2Controller_createOnrampOrder","parameters":[],"requestBody":"32327e0c-8b13-4b10-b871-854e9c6fade1","responses":{"201":"91de1972-8074-4290-9f48-d4aec9c5ea71","400":"aa92df84-d998-4c03-bfe6-6fe66c01086f","401":"7ef98af8-7fa6-4839-9a13-56dc0ec4d7b6"},"security":["d1a26d51-cb83-4b24-8056-328e7658db8e"],"summary":"Create an onramp order","tags":["Pub V2"],"method":"post","type":"path","servers":["48304386-2186-49fe-ad69-f0ee560490f3"],"path":"/pub/v2/onramp","baseUrlOptions":["https://api.paj.cash"],"title":"Create an onramp order","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"currency":{"type":"object","description":"Local currency user wish to use","example":"NGN","isRequired":true,"uniqueKey":"currency","typeLabel":"object"},"recipient":{"type":"string","description":"User wallet address","example":"4C8XFXBPG1Dm2eBs68oixjsVEzjxz5pwTDrLCR17ZRGz","isRequired":true,"uniqueKey":"recipient","typeLabel":"string"},"mint":{"type":"string","description":"Expected token mint address. On TON, a jetton master address or \"TON\" for Toncoin.","example":"EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v","isRequired":true,"uniqueKey":"mint","typeLabel":"string"},"chain":{"type":"object","description":"Wallet Chain","example":"SOLANA","isRequired":true,"uniqueKey":"chain","typeLabel":"object"},"fiatAmount":{"type":"number","description":"Amount user should doposite; in local currency. Mutually exclusive with amount.","example":100,"uniqueKey":"fiatAmount","typeLabel":"number"},"amount":{"type":"number","description":"Amount of token user expected to receive. Mutually exclusive with fiatAmount.","uniqueKey":"amount","typeLabel":"number"},"webhookURL":{"type":"string","description":"Webhook URL to receive order status updates","example":"https://example.com/webhook","uniqueKey":"webhookURL","typeLabel":"string"},"userExternalId":{"type":"string","description":"User external id","example":"user-123","uniqueKey":"userExternalId","typeLabel":"string"},"businessUSDCFee":{"type":"number","description":"Business fee in USDC deducted from the token amount sent to the user","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":["currency","recipient","mint","chain"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"currency":"NGN","recipient":"4C8XFXBPG1Dm2eBs68oixjsVEzjxz5pwTDrLCR17ZRGz","mint":"EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v","chain":"SOLANA","fiatAmount":100,"amount":123,"webhookURL":"https://example.com/webhook","userExternalId":"user-123","businessUSDCFee":0.5,"customerId":"cus_8f2a6c1d9e4b7f03a5c8d2e6b1f4a790","bvn":"22222222222"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"91de1972-8074-4290-9f48-d4aec9c5ea71":{"description":"The created onramp order. accountNumber, accountName and bank are the account to pay; the order stays in INIT until the deposit lands.","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"},"aa92df84-d998-4c03-bfe6-6fe66c01086f":{"description":"The bvn could not be verified, both or neither of amount and fiatAmount were given, or the order failed validation","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"7ef98af8-7fa6-4839-9a13-56dc0ec4d7b6":{"description":"Missing or invalid API key (x-api-key header)","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"d1a26d51-cb83-4b24-8056-328e7658db8e":{"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 onramp order - Paj API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-17T09:33:55.564Z","originalFileLocation":"api-reference/create-onramp-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 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.\">\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 onramp order - Paj API\">\u003cmeta data-mint-head property=\"og:description\" content=\"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.\">\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-onramp-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=Onramp\u0026amp;title=Create+an+onramp+order\u0026amp;description=Opens+an+onramp+order+for+the+API+key%E2%80%99s+business+and+returns+the+virtual+bank+account+the+end+user+pays+into.+Provide+either+amount+%28token%29+or+fiatAmount%2C+not+b\u0026amp;theme=07e22cd0d20fc7185c62ff58\u0026amp;signature=2824cf8b332c97eb8bf51553f50f0b610c82de0bfaa0d30d9934034ec9b738eb\">\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 onramp order - Paj API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"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.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://paj.mintlify.site/_mintlify/api/og/v2?division=Onramp\u0026amp;title=Create+an+onramp+order\u0026amp;description=Opens+an+onramp+order+for+the+API+key%E2%80%99s+business+and+returns+the+virtual+bank+account+the+end+user+pays+into.+Provide+either+amount+%28token%29+or+fiatAmount%2C+not+b\u0026amp;theme=07e22cd0d20fc7185c62ff58\u0026amp;signature=2824cf8b332c97eb8bf51553f50f0b610c82de0bfaa0d30d9934034ec9b738eb\">\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-onramp-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-onramp-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-onramp-order#webpage\",\"url\":\"https://docs.paj.cash/api-reference/create-onramp-order\",\"name\":\"Create an onramp order\",\"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.\",\"dateModified\":\"2026-11-17T09:33:55.564Z\",\"isPartOf\":{\"@id\":\"https://docs.paj.cash#website\"},\"breadcrumb\":{\"@id\":\"https://docs.paj.cash/api-reference/create-onramp-order#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.paj.cash/api-reference/create-onramp-order#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Paj API\",\"item\":\"https://docs.paj.cash\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create an onramp order\",\"item\":\"https://docs.paj.cash/api-reference/create-onramp-order\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.paj.cash/api-reference/create-onramp-order#apireference\",\"headline\":\"Create an onramp order\",\"name\":\"Create an onramp order\",\"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.\",\"url\":\"https://docs.paj.cash/api-reference/create-onramp-order\",\"mainEntityOfPage\":{\"@id\":\"https://docs.paj.cash/api-reference/create-onramp-order#webpage\"},\"dateModified\":\"2026-11-17T09:33:55.564Z\",\"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-onramp-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","description":"Returns the supported banks. Any of the query parameters may be used to narrow the list — code matches exactly, name and country match case-insensitively on a substring. With no parameters every bank is returned.","href":"/api-reference/get-banks"}]},{"group":"Onramp","pages":[{"title":"Create an onramp order","openapi":"POST /pub/v2/onramp","href":"/api-reference/create-onramp-order"}]},{"group":"Offramp","pages":[{"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"}]},{"group":"Transactions","pages":[{"title":"Get a transaction","openapi":"GET /pub/v2/transaction/{id}","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 onramp 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"]}