Creates a merchant-scoped checkout and returns the exact amount and bank account the customer should pay. If a temporary account cannot be generated after retries, the response falls back to the merchant’s permanent NGN account.
Validation failure; missing/oversized or conflicting idempotency headers; no active permanent NGN account; or an amount not greater than a merchant-borne fee.
401
Missing, invalid, or inactive API key.
403
Merchant is not eligible or has not completed business verification.
409
Reference conflict, or an idempotency key is reused with a different body.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"FossaPay","colors":{"primary":"#0066CC","light":"#07C983","dark":"#0080FF"},"logo":{"light":"https://mintcdn.com/fossapay/P03OkYqpKbtpxuak/logo/light.png?fit=max\u0026auto=format\u0026n=P03OkYqpKbtpxuak\u0026q=85\u0026s=1fdb0f379c8126b92430802a7a34cfee","dark":"https://mintcdn.com/fossapay/P03OkYqpKbtpxuak/logo/dark.png?fit=max\u0026auto=format\u0026n=P03OkYqpKbtpxuak\u0026q=85\u0026s=8886a66dbff40d1edb1c472f50b2682b"},"favicon":"https://mintcdn.com/fossapay/P03OkYqpKbtpxuak/favicon.ico?fit=max\u0026auto=format\u0026n=P03OkYqpKbtpxuak\u0026q=85\u0026s=5592701e459c5143ef1e0c926ba2c478","navbar":{"links":[{"href":"mailto:product@fossapay.com","label":"Support"}],"primary":{"type":"button","label":"Get API Access","href":"https://dashboard.fossapay.com/login"}},"footer":{"socials":{"x":"https://x.com/fossapay","github":"https://github.com/fossapay","linkedin":"https://linkedin.com/company/fossapay"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Community","icon":"users","href":"https://t.me/+N1-Gq6L5WStmYWM8"},{"anchor":"Dashboard","icon":"chart-line","href":"https://dashboard.fossapay.com"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"fossapay","hasAudioNarration":false,"actualSubdomain":"fossapay","customDomains":["docs.fossapay.com"],"gitSource":{"type":"github","owner":"codewithmide","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adda9db3f04217bb37161c4","collectionId":"11ef541a-ce49-4414-9fe9-cd123722563f","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adda9db3f04217bb37161c4"},"entitlements":{},"buildId":"6adda9db3f04217bb37161c4","clientVersion":"0.0.4039","searchFilterCounts":[{"language":"default","tag":"API Reference","count":41},{"language":"default","tag":"Documentation","count":16},{"language":"default","tag":"Crypto Wallets","count":10},{"language":"default","tag":"Guides","count":7},{"language":"default","tag":"Virtual Wallets","count":6},{"language":"default","tag":"Bulk Payouts","count":5},{"language":"default","tag":"NGN Transfers","count":5},{"language":"default","tag":"Core Concepts","count":5},{"language":"default","tag":"Checkout Wallet","count":4},{"language":"default","tag":"Customers","count":3}]},"assistantConfig":{"enableStarterQuestions":false},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","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":"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":"llms-txt-v2","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":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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":"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}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/checkouts/create-checkout","slug":"/api-reference/checkouts/create-checkout","pageMetadata":{"title":"Create Checkout","openapi":"api-reference/openapi.json POST /api/v1/checkouts","description":"Create a one-time 30-minute NGN checkout wallet","href":"/api-reference/checkouts/create-checkout"},"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: \"Create a one-time 30-minute NGN checkout wallet\"\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`,p:`p`,pre:`pre`,span:`span`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{CodeBlock,Heading,ParamField,Table,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Creates a merchant-scoped checkout and returns the exact amount and bank account the customer should pay. If a temporary account cannot be generated after retries, the response falls back to the merchant’s permanent NGN account.`}),`\n`,_jsx(Heading,{level:`2`,id:`headers`,children:`Headers`}),`\n`,_jsx(ParamField,{header:`x-api-key`,type:`string`,required:true,id:`param-x-api-key`,children:_jsx(_components.p,{children:`Your existing active FossaPay API key with full permission.`})}),`\n`,_jsx(ParamField,{header:`X-Idempotency-Key`,type:`string`,required:true,id:`param-x-idempotency-key`,children:_jsxs(_components.p,{children:[`A unique key of up to 255 characters. `,_jsx(_components.code,{children:`Idempotency-Key`}),` is also accepted for backward compatibility. If both headers are present, they must match.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`body`,children:`Body`}),`\n`,_jsx(ParamField,{body:`amount`,type:`integer`,required:true,id:`param-amount`,children:_jsxs(_components.p,{children:[`Underlying merchant order amount in NGN. Minimum `,_jsx(_components.code,{children:`1`}),`.`]})}),`\n`,_jsx(ParamField,{body:`currency`,type:`string`,required:true,id:`param-currency`,children:_jsxs(_components.p,{children:[`Currency code. Currently only `,_jsx(_components.code,{children:`NGN`}),` is supported.`]})}),`\n`,_jsx(ParamField,{body:`reference`,type:`string`,required:true,id:`param-reference`,children:_jsxs(_components.p,{children:[`Your unique checkout reference, 1–100 characters. Allowed: letters, numbers, `,_jsx(_components.code,{children:`.`}),`, `,_jsx(_components.code,{children:`_`}),`, `,_jsx(_components.code,{children:`:`}),`, and `,_jsx(_components.code,{children:`-`}),`.`]})}),`\n`,_jsx(ParamField,{body:`feeBearer`,type:`string`,required:true,id:`param-fee-bearer`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`customer`}),` adds the fee to `,_jsx(_components.code,{children:`amountPayable`}),`; `,_jsx(_components.code,{children:`merchant`}),` deducts it from `,_jsx(_components.code,{children:`settlementAmount`}),`.`]})}),`\n`,_jsx(ParamField,{body:`customer`,type:`object`,id:`param-customer`,children:_jsxs(_components.p,{children:[`Optional customer details containing `,_jsx(_components.code,{children:`name`}),`, `,_jsx(_components.code,{children:`email`}),`, and/or `,_jsx(_components.code,{children:`phoneNumber`}),`. A payment-confirmation email is queued after success when `,_jsx(_components.code,{children:`email`}),` is present.`]})}),`\n`,_jsx(ParamField,{body:`metadata`,type:`object`,id:`param-metadata`,children:_jsx(_components.p,{children:`Optional merchant-defined JSON, up to 4,096 UTF-8 bytes. Returned unchanged in responses and webhooks.`})}),`\n`,_jsx(ParamField,{body:`description`,type:`string`,id:`param-description`,children:_jsx(_components.p,{children:`Optional description, up to 255 characters.`})}),`\n`,_jsx(Heading,{level:`2`,id:`request`,children:`Request`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`17`,language:`shellscript`,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:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`17`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` POST`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://api-production.fossapay.com/api/v1/checkouts`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"x-api-key: `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`$FOSSAPAY_API_KEY`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"X-Idempotency-Key: checkout-order-10025-v1\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Content-Type: application/json\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -d`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"amount\": 5000,`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"currency\": \"NGN\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"reference\": \"ORDER-10025\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"feeBearer\": \"customer\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"customer\": {`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"name\": \"John Doe\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"email\": \"john.doe@example.com\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"metadata\": {`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"orderId\": \"10025\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }'`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`response`,children:`Response`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`38`,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:`38`,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:` \"status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"success\"`}),_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:` \"statusCode\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`201`}),_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:` \"message\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Checkout session created successfully\"`}),_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:` \"data\"`}),_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:` \"id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"35f5f6fb-0c8d-4e96-ba4a-c04750724ff6\"`}),_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:` \"reference\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"ORDER-10025\"`}),_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:` \"status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"pending\"`}),_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:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"5000.00\"`}),_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:` \"fee\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"80.00\"`}),_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:` \"amountPayable\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"5080.00\"`}),_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:` \"settlementAmount\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"5000.00\"`}),_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:` \"feeBearer\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"customer\"`}),_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:` \"account\"`}),_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:` \"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"temporary\"`}),_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:` \"bankName\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Sterling Bank\"`}),_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:` \"accountName\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"FOSSAPAY CHECKOUT\"`}),_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:`\"9541382701\"`}),_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:` \"expiresAt\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2026-09-11T10:30:00.000Z\"`})]}),`\n`,_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:` \"customer\"`}),_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:` \"name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"John Doe\"`}),_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:` \"email\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"john.doe@example.com\"`})]}),`\n`,_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:` \"metadata\"`}),_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:` \"orderId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"10025\"`})]}),`\n`,_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:` \"transactionId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"3469cd26-a213-431e-96c9-72dc2dea51ae\"`}),_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:` \"providerCheckoutReference\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`null`}),_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:` \"expiresAt\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2026-09-11T10:30:00.000Z\"`}),_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:` \"completedAt\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`null`}),_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:` \"failedAt\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`null`}),_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:` \"reversedAt\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`null`}),_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:` \"createdAt\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2026-09-11T10:00:00.000Z\"`}),_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:` \"updatedAt\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2026-09-11T10:00:00.000Z\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[`Instruct the customer to transfer exactly `,_jsx(_components.code,{children:`data.amountPayable`}),` once before `,_jsx(_components.code,{children:`data.expiresAt`}),`. Fulfill only after a verified `,_jsx(_components.code,{children:`checkout.completed`}),` webhook.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`errors`,children:`Errors`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`HTTP status`}),_jsx(_components.th,{children:`When it occurs`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`400`})}),_jsx(_components.td,{children:`Validation failure; missing/oversized or conflicting idempotency headers; no active permanent NGN account; or an amount not greater than a merchant-borne fee.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`401`})}),_jsx(_components.td,{children:`Missing, invalid, or inactive API key.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`403`})}),_jsx(_components.td,{children:`Merchant is not eligible or has not completed business verification.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`409`})}),_jsx(_components.td,{children:`Reference conflict, or an idempotency key is reused with a different body.`})]})]})]}),`\n`,_jsxs(_components.p,{children:[`For integration behavior and webhook verification, see the `,_jsx(_components.a,{href:`/guides/checkouts`,children:`Checkout Wallet Guide`}),`.`]})]})}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 Checkout","openapi":"api-reference/openapi.json POST /api/v1/checkouts","description":"Create a one-time 30-minute NGN checkout wallet","href":"/api-reference/checkouts/create-checkout"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Headers","slug":"headers","depth":2,"children":[]},{"title":"Body","slug":"body","depth":2,"children":[]},{"title":"Request","slug":"request","depth":2,"children":[]},{"title":"Response","slug":"response","depth":2,"children":[]},{"title":"Errors","slug":"errors","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"ExternalCheckoutController_create","tags":["Checkout Wallet"],"summary":"Create a 30-minute NGN checkout wallet","parameters":["fe62eec3-a745-4e34-b0cb-f929dc5c3f30"],"requestBody":"44e3f1c7-b862-4711-a791-29cbb3bb427a","responses":{"201":"de516b9a-c442-46bb-9a59-220837400611","400":"f6b4240c-d7b6-41da-827e-6356d51ec7f4","401":"2502f3ce-fe59-4dc0-b6cc-6915f0cf2745","403":"8415ba7b-c171-4fc2-8432-84cc30314118","409":"cc984187-efa9-45a0-87fb-8c7e7c009897"},"method":"post","type":"path","servers":["54b50761-17c4-4458-96ac-039d52a87412"],"security":["ce72eaae-7808-4474-855f-f963b9fae001"],"path":"/api/v1/checkouts","baseUrlOptions":["https://api-production.fossapay.com"],"title":"Create a 30-minute NGN checkout wallet","description":"Create a one-time 30-minute NGN checkout wallet","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"fe62eec3-a745-4e34-b0cb-f929dc5c3f30":{"name":"X-Idempotency-Key","in":"header","required":true,"description":"Unique key for this logical checkout request. Idempotency-Key is also accepted for backward compatibility.","schema":{"type":"string","maxLength":255,"isRequired":true,"description":"Unique key for this logical checkout request. Idempotency-Key is also accepted for backward compatibility.","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["amount","currency","reference","feeBearer"],"properties":{"amount":{"type":"integer","minimum":1,"description":"Underlying merchant order amount in NGN.","isRequired":true,"uniqueKey":"amount","typeLabel":"integer"},"currency":{"type":"string","enum":["NGN"],"isRequired":true,"uniqueKey":"currency","typeLabel":"enum\u003cstring>"},"reference":{"type":"string","minLength":1,"maxLength":100,"pattern":"^[A-Za-z0-9._:-]+$","isRequired":true,"uniqueKey":"reference","typeLabel":"string"},"feeBearer":{"type":"string","enum":["customer","merchant"],"isRequired":true,"uniqueKey":"feeBearer","typeLabel":"enum\u003cstring>"},"customer":{"type":"object","properties":{"name":{"type":"string","minLength":2,"maxLength":150,"uniqueKey":"customer.name","typeLabel":"string"},"email":{"type":"string","format":"email","uniqueKey":"customer.email","typeLabel":"string\u003cemail>"},"phoneNumber":{"type":"string","uniqueKey":"customer.phoneNumber","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"customer","typeLabel":"object"},"metadata":{"type":"object","description":"Optional merchant data limited to 4,096 UTF-8 bytes and returned unchanged.","additionalProperties":true,"uniqueKey":"metadata","typeLabel":"object"},"description":{"type":"string","maxLength":255,"uniqueKey":"description","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"amount":2,"currency":"NGN","reference":"\u003cstring>","customer":{"name":"\u003cstring>","email":"jsmith@example.com","phoneNumber":"\u003cstring>"},"metadata":{},"description":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"de516b9a-c442-46bb-9a59-220837400611":{"description":"Checkout session created or idempotently replayed","content":{"application/json":{"schema":{"type":"object","required":["status","statusCode","message","data"],"properties":{"status":{"type":"string","const":"success","isRequired":true,"uniqueKey":"status","typeLabel":"string"},"statusCode":{"type":"integer","enum":[200,201],"isRequired":true,"uniqueKey":"statusCode","typeLabel":"enum\u003cinteger>"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"data":{"type":"object","required":["id","reference","status","amount","fee","amountPayable","settlementAmount","feeBearer","currency","account","customer","metadata","transactionId","providerCheckoutReference","expiresAt","completedAt","failedAt","reversedAt","createdAt","updatedAt"],"properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"data.id","typeLabel":"string\u003cuuid>"},"reference":{"type":"string","isRequired":true,"uniqueKey":"data.reference","typeLabel":"string"},"status":{"type":"string","enum":["pending","processing","completed","failed","expired","reversed"],"isRequired":true,"uniqueKey":"data.status","typeLabel":"enum\u003cstring>"},"amount":{"type":"string","pattern":"^[0-9]+\\.[0-9]{2}$","isRequired":true,"uniqueKey":"data.amount","typeLabel":"string"},"fee":{"type":"string","pattern":"^[0-9]+\\.[0-9]{2}$","isRequired":true,"uniqueKey":"data.fee","typeLabel":"string"},"amountPayable":{"type":"string","pattern":"^[0-9]+\\.[0-9]{2}$","isRequired":true,"uniqueKey":"data.amountPayable","typeLabel":"string"},"settlementAmount":{"type":"string","pattern":"^[0-9]+\\.[0-9]{2}$","isRequired":true,"uniqueKey":"data.settlementAmount","typeLabel":"string"},"feeBearer":{"type":"string","enum":["customer","merchant"],"isRequired":true,"uniqueKey":"data.feeBearer","typeLabel":"enum\u003cstring>"},"currency":{"type":"string","enum":["NGN"],"isRequired":true,"uniqueKey":"data.currency","typeLabel":"enum\u003cstring>"},"account":{"type":"object","required":["type","bankName","accountName","accountNumber","expiresAt"],"properties":{"type":{"type":"string","enum":["temporary","permanent"],"isRequired":true,"uniqueKey":"data.account.type","typeLabel":"enum\u003cstring>"},"bankName":{"type":"string","isRequired":true,"uniqueKey":"data.account.bankName","typeLabel":"string"},"accountName":{"type":"string","isRequired":true,"uniqueKey":"data.account.accountName","typeLabel":"string"},"accountNumber":{"type":"string","isRequired":true,"uniqueKey":"data.account.accountNumber","typeLabel":"string"},"expiresAt":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"data.account.expiresAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"data.account.expiresAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.account.expiresAt","typeLabel":"string\u003cdate-time> | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"data.account","typeLabel":"object"},"customer":{"oneOf":[{"type":"object","properties":{"name":{"type":"string","minLength":2,"maxLength":150,"uniqueKey":"data.customer.oneOf.0.name","typeLabel":"string"},"email":{"type":"string","format":"email","uniqueKey":"data.customer.oneOf.0.email","typeLabel":"string\u003cemail>"},"phoneNumber":{"type":"string","uniqueKey":"data.customer.oneOf.0.phoneNumber","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"data.customer.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"data.customer.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.customer","typeLabel":"object | null"},"metadata":{"oneOf":[{"type":"object","additionalProperties":true,"isRequired":true,"uniqueKey":"data.metadata.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":true,"isRequired":true,"uniqueKey":"data.metadata.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.metadata","typeLabel":"object | null"},"transactionId":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.transactionId.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.transactionId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.transactionId","typeLabel":"string | null"},"providerCheckoutReference":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.providerCheckoutReference.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.providerCheckoutReference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.providerCheckoutReference","typeLabel":"string | null"},"expiresAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"data.expiresAt","typeLabel":"string\u003cdate-time>"},"completedAt":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"data.completedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"data.completedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.completedAt","typeLabel":"string\u003cdate-time> | null"},"failedAt":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"data.failedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"data.failedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.failedAt","typeLabel":"string\u003cdate-time> | null"},"reversedAt":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"data.reversedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"data.reversedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.reversedAt","typeLabel":"string\u003cdate-time> | null"},"createdAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"data.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"data.updatedAt","typeLabel":"string\u003cdate-time>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"success","statusCode":200,"message":"\u003cstring>","data":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","reference":"\u003cstring>","status":"pending","amount":"\u003cstring>","fee":"\u003cstring>","amountPayable":"\u003cstring>","settlementAmount":"\u003cstring>","feeBearer":"customer","currency":"NGN","account":{"type":"temporary","bankName":"\u003cstring>","accountName":"\u003cstring>","accountNumber":"\u003cstring>","expiresAt":"2023-11-07T05:31:56Z"},"customer":{"name":"\u003cstring>","email":"jsmith@example.com","phoneNumber":"\u003cstring>"},"metadata":{},"transactionId":"\u003cstring>","providerCheckoutReference":"\u003cstring>","expiresAt":"2023-11-07T05:31:56Z","completedAt":"2023-11-07T05:31:56Z","failedAt":"2023-11-07T05:31:56Z","reversedAt":"2023-11-07T05:31:56Z","createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z"}}}},"exampleType":"generated"}},"exampleType":"generated"},"f6b4240c-d7b6-41da-827e-6356d51ec7f4":{"description":"Validation error or missing/conflicting idempotency header","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"oneOf":[{"type":"string","uniqueKey":"status.oneOf.0","typeLabel":"string"},{"type":"boolean","uniqueKey":"status.oneOf.1","typeLabel":"boolean"}],"uniqueKey":"status","typeLabel":"string | boolean"},"statusCode":{"type":"integer","uniqueKey":"statusCode","typeLabel":"integer"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"},"error":{"type":"string","uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","uniqueKey":"code","typeLabel":"string"},"errors":{"type":"object","additionalProperties":true,"uniqueKey":"errors","typeLabel":"object"}},"additionalProperties":true,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"\u003cstring>","statusCode":123,"message":"\u003cstring>","error":"\u003cstring>","code":"\u003cstring>","errors":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"2502f3ce-fe59-4dc0-b6cc-6915f0cf2745":{"description":"Missing, invalid, or inactive API key","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"oneOf":[{"type":"string","uniqueKey":"status.oneOf.0","typeLabel":"string"},{"type":"boolean","uniqueKey":"status.oneOf.1","typeLabel":"boolean"}],"uniqueKey":"status","typeLabel":"string | boolean"},"statusCode":{"type":"integer","uniqueKey":"statusCode","typeLabel":"integer"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"},"error":{"type":"string","uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","uniqueKey":"code","typeLabel":"string"},"errors":{"type":"object","additionalProperties":true,"uniqueKey":"errors","typeLabel":"object"}},"additionalProperties":true,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"\u003cstring>","statusCode":123,"message":"\u003cstring>","error":"\u003cstring>","code":"\u003cstring>","errors":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"8415ba7b-c171-4fc2-8432-84cc30314118":{"description":"Merchant is not eligible","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"oneOf":[{"type":"string","uniqueKey":"status.oneOf.0","typeLabel":"string"},{"type":"boolean","uniqueKey":"status.oneOf.1","typeLabel":"boolean"}],"uniqueKey":"status","typeLabel":"string | boolean"},"statusCode":{"type":"integer","uniqueKey":"statusCode","typeLabel":"integer"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"},"error":{"type":"string","uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","uniqueKey":"code","typeLabel":"string"},"errors":{"type":"object","additionalProperties":true,"uniqueKey":"errors","typeLabel":"object"}},"additionalProperties":true,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"\u003cstring>","statusCode":123,"message":"\u003cstring>","error":"\u003cstring>","code":"\u003cstring>","errors":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"cc984187-efa9-45a0-87fb-8c7e7c009897":{"description":"Reference or idempotency conflict","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"oneOf":[{"type":"string","uniqueKey":"status.oneOf.0","typeLabel":"string"},{"type":"boolean","uniqueKey":"status.oneOf.1","typeLabel":"boolean"}],"uniqueKey":"status","typeLabel":"string | boolean"},"statusCode":{"type":"integer","uniqueKey":"statusCode","typeLabel":"integer"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"},"error":{"type":"string","uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","uniqueKey":"code","typeLabel":"string"},"errors":{"type":"object","additionalProperties":true,"uniqueKey":"errors","typeLabel":"object"}},"additionalProperties":true,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"\u003cstring>","statusCode":123,"message":"\u003cstring>","error":"\u003cstring>","code":"\u003cstring>","errors":{}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"ce72eaae-7808-4474-855f-f963b9fae001":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"54b50761-17c4-4458-96ac-039d52a87412":{"url":"https://api-production.fossapay.com","description":"Production server"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-api-key","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"x-api-key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"x-api-key"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"fossapay","siteName":"FossaPay","title":"Create Checkout - FossaPay","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-15T12:24:10.309Z","originalFileLocation":"api-reference/checkouts/create-checkout.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=\"system\"}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=\"Create a one-time 30-minute NGN checkout wallet\">\u003cmeta data-mint-head name=\"application-name\" content=\"FossaPay\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/fossapay/vSzHd9fg1ESN8fn-/_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/fossapay/vSzHd9fg1ESN8fn-/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/fossapay/vSzHd9fg1ESN8fn-/_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/fossapay/vSzHd9fg1ESN8fn-/_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/fossapay/vSzHd9fg1ESN8fn-/_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/fossapay/vSzHd9fg1ESN8fn-/_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/fossapay/vSzHd9fg1ESN8fn-/_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/fossapay/vSzHd9fg1ESN8fn-/_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/fossapay/vSzHd9fg1ESN8fn-/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create Checkout - FossaPay\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create a one-time 30-minute NGN checkout wallet\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"FossaPay\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.fossapay.com/api-reference/checkouts/create-checkout\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://fossapay.mintlify.app/_mintlify/api/og/v2?division=Checkout+Wallet\u0026amp;title=Create+Checkout\u0026amp;description=Create+a+one-time+30-minute+NGN+checkout+wallet\u0026amp;theme=6dbf89206398ec1903cd51dc\u0026amp;signature=b271560b6a56646b0177d455a614f5107818d8264e27931577207b23f517c5cc\">\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 Checkout - FossaPay\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create a one-time 30-minute NGN checkout wallet\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://fossapay.mintlify.app/_mintlify/api/og/v2?division=Checkout+Wallet\u0026amp;title=Create+Checkout\u0026amp;description=Create+a+one-time+30-minute+NGN+checkout+wallet\u0026amp;theme=6dbf89206398ec1903cd51dc\u0026amp;signature=b271560b6a56646b0177d455a614f5107818d8264e27931577207b23f517c5cc\">\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/fossapay/vSzHd9fg1ESN8fn-/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"FossaPay\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0066CC\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.fossapay.com/api-reference/checkouts/create-checkout\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/checkouts/create-checkout.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.fossapay.com/#organization\",\"name\":\"FossaPay\",\"url\":\"https://docs.fossapay.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/fossapay/P03OkYqpKbtpxuak/logo/light.png?fit=max\u0026auto=format\u0026n=P03OkYqpKbtpxuak\u0026q=85\u0026s=1fdb0f379c8126b92430802a7a34cfee\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.fossapay.com#website\",\"name\":\"FossaPay\",\"url\":\"https://docs.fossapay.com\",\"publisher\":{\"@id\":\"https://docs.fossapay.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.fossapay.com/api-reference/checkouts/create-checkout#webpage\",\"url\":\"https://docs.fossapay.com/api-reference/checkouts/create-checkout\",\"name\":\"Create Checkout\",\"description\":\"Create a one-time 30-minute NGN checkout wallet\",\"dateModified\":\"2026-09-15T12:24:10.309Z\",\"isPartOf\":{\"@id\":\"https://docs.fossapay.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.fossapay.com/api-reference/checkouts/create-checkout#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.fossapay.com/api-reference/checkouts/create-checkout#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"FossaPay\",\"item\":\"https://docs.fossapay.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create Checkout\",\"item\":\"https://docs.fossapay.com/api-reference/checkouts/create-checkout\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.fossapay.com/api-reference/checkouts/create-checkout#apireference\",\"headline\":\"Create Checkout\",\"name\":\"Create Checkout\",\"description\":\"Create a one-time 30-minute NGN checkout wallet\",\"url\":\"https://docs.fossapay.com/api-reference/checkouts/create-checkout\",\"mainEntityOfPage\":{\"@id\":\"https://docs.fossapay.com/api-reference/checkouts/create-checkout#webpage\"},\"dateModified\":\"2026-09-15T12:24:10.309Z\",\"publisher\":{\"@id\":\"https://docs.fossapay.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.fossapay.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"FossaPay\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"FossaPay","nav":{"global":{"anchors":[{"anchor":"Community","icon":"users","href":"https://t.me/+N1-Gq6L5WStmYWM8"},{"anchor":"Dashboard","icon":"chart-line","href":"https://dashboard.fossapay.com"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"Customers","pages":[{"title":"Create Customer Account","openapi":"api-reference/openapi.json POST /api/v1/customers","href":"/api-reference/customers/create-customer"},{"title":"Get All Customers","openapi":"api-reference/openapi.json GET /api/v1/customers","href":"/api-reference/customers/get-all-customers"},{"title":"Get Customer by ID","openapi":"api-reference/openapi.json GET /api/v1/customers/{customerId}","href":"/api-reference/customers/get-customer-by-id"}]},{"group":"Virtual Wallets","pages":[{"title":"Create Wallet","openapi":"api-reference/openapi.json POST /api/v1/wallets/fiat/create","href":"/api-reference/virtual-account/create-wallet"},{"title":"Get Wallet","openapi":"api-reference/openapi.json GET /api/v1/wallets/fiat/{walletId}","href":"/api-reference/virtual-account/get-wallet"},{"title":"Get Master NGN Wallet","openapi":"api-reference/openapi.json GET /api/v1/wallets/fiat/master","href":"/api-reference/virtual-account/get-master-wallet"},{"title":"Get Wallet by Account Number","openapi":"api-reference/openapi.json GET /api/v1/wallets/fiat/account/{accountNumber}","href":"/api-reference/virtual-account/get-wallet-by-account"},{"title":"Fetch Wallet Transactions","openapi":"api-reference/openapi.json GET /api/v1/wallets/fiat/{walletId}/transactions","href":"/api-reference/virtual-account/wallet-transactions"},{"title":"Fetch Wallet Single Transaction","openapi":"api-reference/openapi.json GET /api/v1/wallets/fiat/transactions/{transactionId}","description":"Retrieve details of a single NGN wallet transaction","href":"/api-reference/virtual-account/wallet-transaction"}]},{"group":"Checkout Wallet","pages":[{"title":"Create Checkout","openapi":"api-reference/openapi.json POST /api/v1/checkouts","href":"/api-reference/checkouts/create-checkout"},{"title":"Get Checkout by ID","openapi":"api-reference/openapi.json GET /api/v1/checkouts/{id}","description":"Retrieve a checkout wallet using its FossaPay ID","href":"/api-reference/checkouts/get-checkout"},{"title":"Get Checkout by Reference","openapi":"api-reference/openapi.json GET /api/v1/checkouts/reference/{reference}","href":"/api-reference/checkouts/get-checkout-by-reference"},{"title":"Expire Checkout","openapi":"api-reference/openapi.json POST /api/v1/checkouts/{id}/expire","href":"/api-reference/checkouts/expire-checkout"}]},{"group":"Identity Verification","pages":[{"title":"Verify Identity","openapi":"api-reference/openapi.json POST /api/v1/kyc/verifications","href":"/api-reference/identity-verification/verify-identity"}]},{"group":"Master Wallet Payouts","pages":[{"title":"Create Master Wallet Payout","openapi":"api-reference/openapi.json POST /api/v1/payouts","href":"/api-reference/payouts/create-payout"},{"title":"Get Payout by ID","openapi":"api-reference/openapi.json GET /api/v1/payouts/{id}","href":"/api-reference/payouts/get-payout"},{"title":"Get Payout by Reference","openapi":"api-reference/openapi.json GET /api/v1/payouts/reference/{reference}","href":"/api-reference/payouts/get-payout-by-reference"}]},{"group":"NGN Transfers","pages":[{"title":"Get Supported Banks","openapi":"api-reference/openapi.json GET /api/v1/transfers/fiat/banks","href":"/api-reference/fiat-transfers/get-supported-banks"},{"title":"Bank Name Enquiry","openapi":"api-reference/openapi.json POST /api/v1/transfers/fiat/bank-name-enquiry","href":"/api-reference/fiat-transfers/bank-name-enquiry"},{"title":"Wallet-to-Wallet Transfer (Free)","openapi":"api-reference/openapi.json POST /api/v1/wallets/fiat/transfers/wallet-to-wallet","href":"/api-reference/virtual-account/wallet-transfer"},{"title":"Inter-Bank Transfer (External Bank)","openapi":"api-reference/openapi.json POST /api/v1/transfers/fiat/inter-bank","href":"/api-reference/fiat-transfers/inter-bank-transfer"},{"title":"Calculate NGN Transfer Fee","openapi":"api-reference/openapi.json GET /api/v1/transfers/fiat/calculate-fee","href":"/api-reference/fiat-transfers/calculate-fee"}]},{"group":"Bulk Payouts","pages":[{"title":"Create Bulk Payout Batch","openapi":"api-reference/openapi.json POST /api/v1/payouts/batches","playground":"interactive","href":"/api-reference/bulk-payouts/create-batch"},{"title":"List Bulk Payout Batches","openapi":"api-reference/openapi.json GET /api/v1/payouts/batches","playground":"interactive","href":"/api-reference/bulk-payouts/list-batches"},{"title":"Get Bulk Payout Batch","openapi":"api-reference/openapi.json GET /api/v1/payouts/batches/{batchId}","playground":"interactive","href":"/api-reference/bulk-payouts/get-batch"},{"title":"Get Bulk Payout Recipients","openapi":"api-reference/openapi.json GET /api/v1/payouts/batches/{batchId}/recipients","playground":"interactive","href":"/api-reference/bulk-payouts/get-batch-recipients"},{"title":"Get Bulk Payout Status","openapi":"api-reference/openapi.json GET /api/v1/payouts/batches/{batchId}/status","playground":"interactive","href":"/api-reference/bulk-payouts/get-batch-status"}]},{"group":"Crypto Wallets","pages":[{"title":"Create Crypto Wallet","openapi":"api-reference/openapi.json POST /api/v1/wallets/crypto/create","href":"/api-reference/crypto-wallets/create-wallet"},{"title":"Create Master Crypto Wallet","openapi":"api-reference/openapi.json POST /api/v1/wallets/crypto/master/create","href":"/api-reference/crypto-wallets/create-master-wallet"},{"title":"Get Master Crypto Wallet","openapi":"api-reference/openapi.json GET /api/v1/wallets/crypto/master","href":"/api-reference/crypto-wallets/get-master-wallet"},{"title":"Get Customer Wallet Balance","openapi":"api-reference/openapi.json GET /api/v1/wallets/crypto/customer/{customerId}/balance","href":"/api-reference/crypto-wallets/get-customer-balance"},{"title":"Sign a Master Wallet Transaction","openapi":"api-reference/openapi.json POST /api/v1/wallets/crypto/master/transactions/sign-and-broadcast","href":"/api-reference/crypto-wallets/sign-master-transaction"},{"title":"Sign a Customer Wallet Transaction","openapi":"api-reference/openapi.json POST /api/v1/wallets/crypto/customer/{customerId}/transactions/sign-and-broadcast","href":"/api-reference/crypto-wallets/sign-customer-transaction"},{"title":"Get Wallet by ID","openapi":"api-reference/openapi.json GET /api/v1/wallets/crypto/{walletId}","href":"/api-reference/crypto-wallets/get-wallet-by-id"},{"title":"Get Wallet by Address","openapi":"api-reference/openapi.json GET /api/v1/wallets/crypto/address/{address}","href":"/api-reference/crypto-wallets/get-wallet-by-address"},{"title":"Get All Wallet Transactions","openapi":"api-reference/openapi.json GET /api/v1/wallets/crypto/{walletId}/transactions","href":"/api-reference/crypto-wallets/wallet-transactions"},{"title":"Get Wallet Single Transaction","openapi":"api-reference/openapi.json GET /api/v1/wallets/crypto/transactions/{transactionId}","href":"/api-reference/crypto-wallets/wallet-transaction"}]},{"group":"Crypto Transfers","pages":[{"title":"Crypto Transfer","openapi":"api-reference/openapi.json POST /api/v1/transfers/crypto","href":"/api-reference/crypto-transfers/crypto-transfer"},{"title":"Calculate Crypto Transfer Fee","openapi":"api-reference/openapi.json GET /api/v1/transfers/crypto/calculate-fee","href":"/api-reference/crypto-transfers/calculate-fee"}]},{"group":"Webhooks","pages":[{"title":"Webhooks Overview","href":"/api-reference/webhooks/overview"},{"title":"Webhook Events","href":"/api-reference/webhooks/events"}]}]},{"tab":"SDKs","pages":[{"title":"SDKs","href":"/sdks/overview"}]}]},"basePath":"","title":"Create Checkout - FossaPay","buildId":"dpl_77Hw7ZuAABM8E3WMbYAf2ohQCr3v","deploymentId":"dpl_77Hw7ZuAABM8E3WMbYAf2ohQCr3v","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CVpqyvFO.js","utils-vpweLD0v.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BIOodqb0.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B1LM3qmu.js","snippetPresets-C5xK0GtN.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CCsxLnQl.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C2-WKG22.js","shallow-SdoLUC-q.js","getApiPlaygroundDisplay-BnI8L2hB.js","CodeSnippet-D5M8NCHI.js","CodeSnippets-CXRO8Uom.js","Page-CN9QbZiA.js","getPastedJson-CrfHEdRt.js","icon-Cr8AyUnW.js","MethodPill-J_Cs0kNw.js","DuplicateIcon-DrMboxGw.js","createIcon-B4CIWVbU.js","DynamicMarkdown-D9cdbgj9.js","SectionHeading-BO4CouT0.js","axios-vUo_bRtp.js","Markdown-L1m1-PSi.js","clsx-rIpTdK8h.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-ptfS1uB_.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-D31Sm3f9.js"]}