Creates a new invoice. If asset is omitted, the customer picks the currency on the hosted checkout (the deposit address is allocated only after the choice is made).
Invoice settlement mode. STATIC — fixed-price service purchase: the invoice expects exactly amount. An underpayment moves it to partially_paid (NOT finalized) so the client can top up to the full amount; the address keeps listening until the invoice expires or reaches success/paid_over. VARY — open-ended balance top-up: any incoming payment finalises the invoice (success if it covers amount, partially_paid (finalized) if less). Required value when permanent_address=true.
Available options:
VARY,
STATIC
asset
string | null
chain
string | null
extra
string | null
Required string length: 1 - 64
Pattern: ^[A-Za-z0-9_-]{1,64}$
notify_url
string | null
Maximum string length: 500
ttl
integer
default:3600
Required range: 300 <= x <= 86400
metadata
Metadata · object | null
title
string | null
Maximum string length: 150
description
string | null
Maximum string length: 500
underpay_tolerance
number | null
Required range: 0 <= x <= 10
accepted_coins
string[] | null
excluded_coins
string[] | null
on_paid_url
string | null
Maximum string length: 500
on_cancel_url
string | null
Maximum string length: 500
price_modifier
number | null
Required range: -90 <= x <= 90
fee_bearer
enum<string> | null
Who pays the platform commission. client adds it on top of the amount the customer pays; merchant deducts it from the merchant's credited amount. When omitted, the merchant's configured default_fee_bearer is used (which itself defaults to client).
Available options:
merchant,
client
payer_info
Payer Info · object | null
webhook_format
enum<string> | null
Available options:
native_v2,
cryptomus,
heleket,
nowpayments,
coinpayments,
coinpayments_v2
permanent_address
boolean
default:false
If true, bind this invoice to the permanent deposit address for (merchant, user_id, asset family). The address is created on first use and reused thereafter. Requires billing_type=VARY and a non-empty user_id. If asset is provided the address is allocated immediately; if omitted, the address is allocated when the customer selects a currency on the hosted checkout. XMR is not supported for permanent addresses.
user_id
string | null
External user identifier — required when permanent_address=true.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"PawPayments API","colors":{"primary":"#6366F1","light":"#818CF8","dark":"#6366F1"},"logo":{"light":"https://mintcdn.com/pawpaymentsinc/GvUEHrxVBBZGqu1B/logo/light.png?fit=max\u0026auto=format\u0026n=GvUEHrxVBBZGqu1B\u0026q=85\u0026s=e63c9c4d933201f4ef804ee6b424f0df","dark":"https://mintcdn.com/pawpaymentsinc/GvUEHrxVBBZGqu1B/logo/dark.png?fit=max\u0026auto=format\u0026n=GvUEHrxVBBZGqu1B\u0026q=85\u0026s=329208374dd84350bd253aac43332e16","href":"https://pawpayments.com"},"favicon":"https://mintcdn.com/pawpaymentsinc/GvUEHrxVBBZGqu1B/favicon.png?fit=max\u0026auto=format\u0026n=GvUEHrxVBBZGqu1B\u0026q=85\u0026s=f1058fcf9d51a71711e5de8f50095260","navbar":{"links":[{"href":"/plugins/overview","label":"Plugins \u0026 SDKs"},{"href":"https://pawpayments.com","label":"Dashboard"}],"primary":{"type":"button","label":"Get an API key","href":"https://pawpayments.com"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"pawpaymentsinc","hasAudioNarration":false,"actualSubdomain":"pawpaymentsinc","customDomains":["docs.pawpayments.com"],"gitSource":{"type":"github","owner":"pawpayments","repo":"docs","deployBranch":"main","isPrivate":false,"contentDirectory":"","mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6af4bfb1775e4ad0c10ecd70","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"Documentation","count":20},{"language":"default","tag":"API Reference","count":20},{"language":"default","tag":"Plugins \u0026 SDKs","count":8},{"language":"default","tag":"Introduction","count":7},{"language":"default","tag":"Migrate from another provider","count":5},{"language":"default","tag":"Invoices","count":5},{"language":"default","tag":"Payouts","count":4},{"language":"default","tag":"Permanent addresses","count":4},{"language":"default","tag":"Catalog","count":2},{"language":"default","tag":"Merchant","count":2}]},"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":"site-roles","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},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[]}
{"page":{"pagePath":"api-reference/invoices/create-an-invoice","slug":"/api-reference/invoices/create-an-invoice","pageMetadata":{"title":"Create an invoice","description":"Creates a new invoice. If `asset` is omitted, the customer picks the currency on the hosted checkout (the deposit address is allocated only after the choice is made).","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/invoices","href":"/api-reference/invoices/create-an-invoice","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Creates a new invoice. If \", _jsx(_components.code, {\n children: \"asset\"\n }), \" is omitted, the customer picks the currency on the hosted checkout (the deposit address is allocated only after the choice is made).\"]\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}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create an invoice","description":"Creates a new invoice. If `asset` is omitted, the customer picks the currency on the hosted checkout (the deposit address is allocated only after the choice is made).","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/invoices","href":"/api-reference/invoices/create-an-invoice","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Create an invoice","operationId":"post__api_v2_invoices","description":"Creates a new invoice. If `asset` is omitted, the customer picks the currency on the hosted checkout (the deposit address is allocated only after the choice is made).","tags":["Invoices"],"parameters":[],"responses":{"201":"4f45c514-8a98-4f0e-b773-a33a4bb0a83b","400":"61b206b0-c571-46af-b84a-d9cda0c73635","401":"e2e8f923-7252-4314-a2a8-58edc751081f","404":"5237538d-8e26-4d26-a08b-6f4b9f17fba7","422":"30a46752-68a0-45f0-956e-d28afa01b85a"},"requestBody":"3dfe5663-65e8-4521-b78d-7129f68debd1","method":"post","type":"path","servers":["67ba0a1a-6bda-4cd2-867f-8a352a5d97f3"],"security":["7fe6fa50-6efa-4362-986f-7c08b1521f52"],"path":"/api/v2/invoices","baseUrlOptions":["https://api.pawpayments.com"],"title":"Create an invoice","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"properties":{"amount":{"oneOf":[{"type":"number","title":"Amount","minimum":0,"exclusiveMinimum":true,"isRequired":true,"uniqueKey":"amount.oneOf.0","typeLabel":"number"},{"type":"string","title":"Amount","isRequired":true,"uniqueKey":"amount.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"amount","typeLabel":"number | string"},"fiat_currency":{"title":"Fiat Currency","type":"string","isRequired":true,"uniqueKey":"fiat_currency","typeLabel":"string"},"billing_type":{"description":"Invoice settlement mode. `STATIC` — fixed-price service purchase: the invoice expects exactly `amount`. An underpayment moves it to `partially_paid` (NOT finalized) so the client can top up to the full amount; the address keeps listening until the invoice expires or reaches `success`/`paid_over`. `VARY` — open-ended balance top-up: any incoming payment finalises the invoice (`success` if it covers `amount`, `partially_paid` (finalized) if less). Required value when `permanent_address=true`.","enum":["VARY","STATIC"],"title":"Billing Type","type":"string","isRequired":true,"uniqueKey":"billing_type","typeLabel":"enum\u003cstring>"},"asset":{"oneOf":[{"type":"string","title":"Asset","uniqueKey":"asset.oneOf.0","typeLabel":"string"},{"type":"null","title":"Asset","uniqueKey":"asset.oneOf.1","typeLabel":"null"}],"uniqueKey":"asset","typeLabel":"string | null"},"chain":{"oneOf":[{"type":"string","title":"Chain","uniqueKey":"chain.oneOf.0","typeLabel":"string"},{"type":"null","title":"Chain","uniqueKey":"chain.oneOf.1","typeLabel":"null"}],"uniqueKey":"chain","typeLabel":"string | null"},"extra":{"oneOf":[{"type":"string","title":"Extra","maxLength":64,"minLength":1,"pattern":"^[A-Za-z0-9_-]{1,64}$","uniqueKey":"extra.oneOf.0","typeLabel":"string"},{"type":"null","title":"Extra","uniqueKey":"extra.oneOf.1","typeLabel":"null"}],"uniqueKey":"extra","typeLabel":"string | null"},"notify_url":{"oneOf":[{"type":"string","title":"Notify Url","maxLength":500,"uniqueKey":"notify_url.oneOf.0","typeLabel":"string"},{"type":"null","title":"Notify Url","uniqueKey":"notify_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"notify_url","typeLabel":"string | null"},"ttl":{"default":3600,"maximum":86400,"minimum":300,"title":"Ttl","type":"integer","uniqueKey":"ttl","typeLabel":"integer"},"metadata":{"oneOf":[{"type":"object","title":"Metadata","uniqueKey":"metadata.oneOf.0","typeLabel":"Metadata · object"},{"type":"null","title":"Metadata","uniqueKey":"metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"metadata","typeLabel":"Metadata · object | null"},"title":{"oneOf":[{"type":"string","title":"Title","maxLength":150,"uniqueKey":"title.oneOf.0","typeLabel":"string"},{"type":"null","title":"Title","uniqueKey":"title.oneOf.1","typeLabel":"null"}],"uniqueKey":"title","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","title":"Description","maxLength":500,"uniqueKey":"description.oneOf.0","typeLabel":"string"},{"type":"null","title":"Description","uniqueKey":"description.oneOf.1","typeLabel":"null"}],"uniqueKey":"description","typeLabel":"string | null"},"underpay_tolerance":{"oneOf":[{"type":"number","title":"Underpay Tolerance","maximum":10,"minimum":0,"uniqueKey":"underpay_tolerance.oneOf.0","typeLabel":"number"},{"type":"null","title":"Underpay Tolerance","uniqueKey":"underpay_tolerance.oneOf.1","typeLabel":"null"}],"uniqueKey":"underpay_tolerance","typeLabel":"number | null"},"accepted_coins":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"accepted_coins.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Accepted Coins","uniqueKey":"accepted_coins.oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Accepted Coins","uniqueKey":"accepted_coins.oneOf.1","typeLabel":"null"}],"uniqueKey":"accepted_coins","typeLabel":"string[] | null"},"excluded_coins":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"excluded_coins.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Excluded Coins","uniqueKey":"excluded_coins.oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Excluded Coins","uniqueKey":"excluded_coins.oneOf.1","typeLabel":"null"}],"uniqueKey":"excluded_coins","typeLabel":"string[] | null"},"on_paid_url":{"oneOf":[{"type":"string","title":"On Paid Url","maxLength":500,"uniqueKey":"on_paid_url.oneOf.0","typeLabel":"string"},{"type":"null","title":"On Paid Url","uniqueKey":"on_paid_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"on_paid_url","typeLabel":"string | null"},"on_cancel_url":{"oneOf":[{"type":"string","title":"On Cancel Url","maxLength":500,"uniqueKey":"on_cancel_url.oneOf.0","typeLabel":"string"},{"type":"null","title":"On Cancel Url","uniqueKey":"on_cancel_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"on_cancel_url","typeLabel":"string | null"},"price_modifier":{"oneOf":[{"type":"number","title":"Price Modifier","maximum":90,"minimum":-90,"uniqueKey":"price_modifier.oneOf.0","typeLabel":"number"},{"type":"null","title":"Price Modifier","uniqueKey":"price_modifier.oneOf.1","typeLabel":"null"}],"uniqueKey":"price_modifier","typeLabel":"number | null"},"fee_bearer":{"oneOf":[{"type":"string","title":"Fee Bearer","description":"Who pays the platform commission. `client` adds it on top of the amount the customer pays; `merchant` deducts it from the merchant's credited amount. When omitted, the merchant's configured `default_fee_bearer` is used (which itself defaults to `client`).","enum":["merchant","client"],"uniqueKey":"fee_bearer.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","title":"Fee Bearer","description":"Who pays the platform commission. `client` adds it on top of the amount the customer pays; `merchant` deducts it from the merchant's credited amount. When omitted, the merchant's configured `default_fee_bearer` is used (which itself defaults to `client`).","uniqueKey":"fee_bearer.oneOf.1","typeLabel":"null"}],"uniqueKey":"fee_bearer","typeLabel":"enum\u003cstring> | null"},"payer_info":{"oneOf":[{"type":"object","title":"Payer Info","uniqueKey":"payer_info.oneOf.0","typeLabel":"Payer Info · object"},{"type":"null","title":"Payer Info","uniqueKey":"payer_info.oneOf.1","typeLabel":"null"}],"uniqueKey":"payer_info","typeLabel":"Payer Info · object | null"},"webhook_format":{"oneOf":[{"type":"string","title":"Webhook Format","enum":["native_v2","cryptomus","heleket","nowpayments","coinpayments","coinpayments_v2"],"uniqueKey":"webhook_format.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","title":"Webhook Format","uniqueKey":"webhook_format.oneOf.1","typeLabel":"null"}],"uniqueKey":"webhook_format","typeLabel":"enum\u003cstring> | null"},"permanent_address":{"default":false,"description":"If true, bind this invoice to the permanent deposit address for (merchant, user_id, asset family). The address is created on first use and reused thereafter. Requires `billing_type=VARY` and a non-empty `user_id`. If `asset` is provided the address is allocated immediately; if omitted, the address is allocated when the customer selects a currency on the hosted checkout. XMR is not supported for permanent addresses.","title":"Permanent Address","type":"boolean","uniqueKey":"permanent_address","typeLabel":"boolean"},"user_id":{"oneOf":[{"type":"string","title":"User Id","description":"External user identifier — required when `permanent_address=true`.","maxLength":128,"minLength":1,"uniqueKey":"user_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"User Id","description":"External user identifier — required when `permanent_address=true`.","uniqueKey":"user_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"user_id","typeLabel":"string | null"}},"required":["amount","fiat_currency","billing_type"],"title":"CreateInvoiceV2","type":"object","uniqueKey":"","typeLabel":"CreateInvoiceV2 · object"},"examples":{"Example":{"title":"Example","value":{"amount":1,"fiat_currency":"\u003cstring>","asset":"\u003cstring>","chain":"\u003cstring>","extra":"\u003cstring>","notify_url":"\u003cstring>","ttl":3600,"metadata":{},"title":"\u003cstring>","description":"\u003cstring>","underpay_tolerance":5,"accepted_coins":["\u003cstring>"],"excluded_coins":["\u003cstring>"],"on_paid_url":"\u003cstring>","on_cancel_url":"\u003cstring>","price_modifier":0,"payer_info":{},"permanent_address":false,"user_id":"\u003cstring>"}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"4f45c514-8a98-4f0e-b773-a33a4bb0a83b":{"description":"Created","content":{"application/json":{"schema":{"properties":{"ok":{"const":true,"title":"Ok","type":"boolean","isRequired":true,"uniqueKey":"ok","typeLabel":"boolean"},"result":{"example":{"accepted_coins":["usdt_tron","usdc_eth"],"address_from":null,"address_to":"TXk2Y5...redacted","amount":49.5,"asset":"usdt_tron","billing_type":"fiat","created_at":1763398800,"description":"1 month subscription","excluded_coins":null,"expires_at":1763400600,"extra":"order-12345","fee_bearer":"merchant","fiat_amount":50,"fiat_currency":"USD","initial_amount":49.5,"initial_asset":"usdt_tron","initial_fiat_amount":50,"metadata":{"customer_id":"u_42"},"notify_url":"https://shop.example.com/webhook/paw","on_cancel_url":"https://shop.example.com/cancel","on_paid_url":"https://shop.example.com/thanks","order_id":"65f1c3a4e8b1c2d3a4b5c6d7","original_amount":50,"payer_info":null,"payment_url":"https://pawpayments.com/checkout/f2c8a3d1-4b7e-4f8a-9c1d-2e3b4a5c6d7e","permanent_address_id":null,"price_modifier":-1,"processed_at":null,"received_amount":0,"status":"created","title":"Premium plan","txid":null,"type":"token","underpay_tolerance":2.5,"user_id":null},"properties":{"order_id":{"description":"Unique 24-character hex invoice id.","title":"Order Id","type":"string","isRequired":true,"uniqueKey":"result.order_id","typeLabel":"string"},"external_id":{"oneOf":[{"type":"string","title":"External Id","description":"Public checkout id (UUID). Sent in webhooks only — it doubles as the payer's self-refund credential, so the invoice read endpoints withhold it. Store the `payment_url` returned when the invoice is created if you need the hosted-checkout link later.","uniqueKey":"result.external_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"External Id","description":"Public checkout id (UUID). Sent in webhooks only — it doubles as the payer's self-refund credential, so the invoice read endpoints withhold it. Store the `payment_url` returned when the invoice is created if you need the hosted-checkout link later.","uniqueKey":"result.external_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"result.external_id","typeLabel":"string | null"},"status":{"oneOf":[{"type":"string","title":"Status","description":"One of: created, confirming, partially_paid, paid_over, success, failed, high_risk, expired, cancelled, refunding, refunded, refund_failed_needs_review (the last three: a high_risk payment being returned to the payer). Terminal-expiry split: `cancelled` is reachable only from `partially_paid` + `billing_type=STATIC` (merchant was already credited the partial amount at AML time; the credit is kept on expiry — `cancelled` reports the final under-paid state without reversal). Everything else still in `created` at TTL (including the sub-$2 tiny-payment deferral path that stored `received_amount` without enqueueing AML) → `expired`. `partially_paid` + `billing_type=VARY` is terminal at AML time and never transitions on TTL.","uniqueKey":"result.status.oneOf.0","typeLabel":"string"},{"type":"null","title":"Status","description":"One of: created, confirming, partially_paid, paid_over, success, failed, high_risk, expired, cancelled, refunding, refunded, refund_failed_needs_review (the last three: a high_risk payment being returned to the payer). Terminal-expiry split: `cancelled` is reachable only from `partially_paid` + `billing_type=STATIC` (merchant was already credited the partial amount at AML time; the credit is kept on expiry — `cancelled` reports the final under-paid state without reversal). Everything else still in `created` at TTL (including the sub-$2 tiny-payment deferral path that stored `received_amount` without enqueueing AML) → `expired`. `partially_paid` + `billing_type=VARY` is terminal at AML time and never transitions on TTL.","uniqueKey":"result.status.oneOf.1","typeLabel":"null"}],"uniqueKey":"result.status","typeLabel":"string | null"},"asset":{"oneOf":[{"type":"string","title":"Asset","uniqueKey":"result.asset.oneOf.0","typeLabel":"string"},{"type":"null","title":"Asset","uniqueKey":"result.asset.oneOf.1","typeLabel":"null"}],"uniqueKey":"result.asset","typeLabel":"string | null"},"initial_asset":{"oneOf":[{"type":"string","title":"Initial Asset","description":"Asset originally requested at invoice creation. Immutable after first assignment — if the customer changes the payment currency on the hosted checkout, `asset` reflects the new choice while `initial_asset` keeps the original one.","uniqueKey":"result.initial_asset.oneOf.0","typeLabel":"string"},{"type":"null","title":"Initial Asset","description":"Asset originally requested at invoice creation. Immutable after first assignment — if the customer changes the payment currency on the hosted checkout, `asset` reflects the new choice while `initial_asset` keeps the original one.","uniqueKey":"result.initial_asset.oneOf.1","typeLabel":"null"}],"uniqueKey":"result.initial_asset","typeLabel":"string | null"},"type":{"oneOf":[{"type":"string","title":"Type","description":"Asset type: `native` or `token`.","uniqueKey":"result.type.oneOf.0","typeLabel":"string"},{"type":"null","title":"Type","description":"Asset type: `native` or `token`.","uniqueKey":"result.type.oneOf.1","typeLabel":"null"}],"uniqueKey":"result.type","typeLabel":"string | null"},"amount":{"oneOf":[{"type":"number","title":"Amount","description":"Originally requested amount in `asset`.","uniqueKey":"result.amount.oneOf.0","typeLabel":"number"},{"type":"null","title":"Amount","description":"Originally requested amount in `asset`.","uniqueKey":"result.amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"result.amount","typeLabel":"number | null"},"initial_amount":{"oneOf":[{"type":"number","title":"Initial Amount","description":"Snapshot of the originally requested crypto amount (immutable; equals `amount`).","uniqueKey":"result.initial_amount.oneOf.0","typeLabel":"number"},{"type":"null","title":"Initial Amount","description":"Snapshot of the originally requested crypto amount (immutable; equals `amount`).","uniqueKey":"result.initial_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"result.initial_amount","typeLabel":"number | null"},"fiat_amount":{"oneOf":[{"type":"number","title":"Fiat Amount","description":"Cumulative amount paid in `fiat_currency`. Updated on each on-chain payment.","uniqueKey":"result.fiat_amount.oneOf.0","typeLabel":"number"},{"type":"null","title":"Fiat Amount","description":"Cumulative amount paid in `fiat_currency`. Updated on each on-chain payment.","uniqueKey":"result.fiat_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"result.fiat_amount","typeLabel":"number | null"},"initial_fiat_amount":{"oneOf":[{"type":"number","title":"Initial Fiat Amount","description":"Originally requested amount in `fiat_currency` (immutable; useful when `fiat_amount` becomes a partial sum).","uniqueKey":"result.initial_fiat_amount.oneOf.0","typeLabel":"number"},{"type":"null","title":"Initial Fiat Amount","description":"Originally requested amount in `fiat_currency` (immutable; useful when `fiat_amount` becomes a partial sum).","uniqueKey":"result.initial_fiat_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"result.initial_fiat_amount","typeLabel":"number | null"},"fiat_currency":{"oneOf":[{"type":"string","title":"Fiat Currency","uniqueKey":"result.fiat_currency.oneOf.0","typeLabel":"string"},{"type":"null","title":"Fiat Currency","uniqueKey":"result.fiat_currency.oneOf.1","typeLabel":"null"}],"uniqueKey":"result.fiat_currency","typeLabel":"string | null"},"billing_type":{"oneOf":[{"type":"string","title":"Billing Type","description":"Settlement mode: `STATIC` (fixed-price service — `partially_paid` keeps the invoice open for top-ups until `success`/`paid_over`/`expires_at`) or `VARY` (any incoming payment finalises the invoice — used for balance top-ups and for invoices bound to permanent addresses).","uniqueKey":"result.billing_type.oneOf.0","typeLabel":"string"},{"type":"null","title":"Billing Type","description":"Settlement mode: `STATIC` (fixed-price service — `partially_paid` keeps the invoice open for top-ups until `success`/`paid_over`/`expires_at`) or `VARY` (any incoming payment finalises the invoice — used for balance top-ups and for invoices bound to permanent addresses).","uniqueKey":"result.billing_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"result.billing_type","typeLabel":"string | null"},"address_to":{"oneOf":[{"type":"string","title":"Address To","uniqueKey":"result.address_to.oneOf.0","typeLabel":"string"},{"type":"null","title":"Address To","uniqueKey":"result.address_to.oneOf.1","typeLabel":"null"}],"uniqueKey":"result.address_to","typeLabel":"string | null"},"deposit_tag":{"oneOf":[{"type":"integer","title":"Deposit Tag","description":"XRP only. All XRP invoices are paid to one shared gateway address, so the payment MUST carry this destination tag — it is what identifies the invoice. A payment without it is rejected by the ledger. Absent on every other network, where `address_to` is unique per invoice.","uniqueKey":"result.deposit_tag.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Deposit Tag","description":"XRP only. All XRP invoices are paid to one shared gateway address, so the payment MUST carry this destination tag — it is what identifies the invoice. A payment without it is rejected by the ledger. Absent on every other network, where `address_to` is unique per invoice.","uniqueKey":"result.deposit_tag.oneOf.1","typeLabel":"null"}],"uniqueKey":"result.deposit_tag","typeLabel":"integer | null"},"address_from":{"oneOf":[{"type":"string","title":"Address From","description":"Sender address of the (last) on-chain payment, when known.","uniqueKey":"result.address_from.oneOf.0","typeLabel":"string"},{"type":"null","title":"Address From","description":"Sender address of the (last) on-chain payment, when known.","uniqueKey":"result.address_from.oneOf.1","typeLabel":"null"}],"uniqueKey":"result.address_from","typeLabel":"string | null"},"extra":{"oneOf":[{"type":"string","title":"Extra","uniqueKey":"result.extra.oneOf.0","typeLabel":"string"},{"type":"null","title":"Extra","uniqueKey":"result.extra.oneOf.1","typeLabel":"null"}],"uniqueKey":"result.extra","typeLabel":"string | null"},"title":{"oneOf":[{"type":"string","title":"Title","uniqueKey":"result.title.oneOf.0","typeLabel":"string"},{"type":"null","title":"Title","uniqueKey":"result.title.oneOf.1","typeLabel":"null"}],"uniqueKey":"result.title","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","title":"Description","uniqueKey":"result.description.oneOf.0","typeLabel":"string"},{"type":"null","title":"Description","uniqueKey":"result.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"result.description","typeLabel":"string | null"},"expires_at":{"oneOf":[{"type":"integer","title":"Expires At","description":"Unix timestamp when the invoice stops accepting new deposits.","uniqueKey":"result.expires_at.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Expires At","description":"Unix timestamp when the invoice stops accepting new deposits.","uniqueKey":"result.expires_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"result.expires_at","typeLabel":"integer | null"},"metadata":{"oneOf":[{"type":"object","title":"Metadata","uniqueKey":"result.metadata.oneOf.0","typeLabel":"Metadata · object"},{"type":"null","title":"Metadata","uniqueKey":"result.metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"result.metadata","typeLabel":"Metadata · object | null"},"fee_bearer":{"oneOf":[{"type":"string","title":"Fee Bearer","uniqueKey":"result.fee_bearer.oneOf.0","typeLabel":"string"},{"type":"null","title":"Fee Bearer","uniqueKey":"result.fee_bearer.oneOf.1","typeLabel":"null"}],"uniqueKey":"result.fee_bearer","typeLabel":"string | null"},"underpay_tolerance":{"oneOf":[{"type":"number","title":"Underpay Tolerance","uniqueKey":"result.underpay_tolerance.oneOf.0","typeLabel":"number"},{"type":"null","title":"Underpay Tolerance","uniqueKey":"result.underpay_tolerance.oneOf.1","typeLabel":"null"}],"uniqueKey":"result.underpay_tolerance","typeLabel":"number | null"},"accepted_coins":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"result.accepted_coins.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Accepted Coins","uniqueKey":"result.accepted_coins.oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Accepted Coins","uniqueKey":"result.accepted_coins.oneOf.1","typeLabel":"null"}],"uniqueKey":"result.accepted_coins","typeLabel":"string[] | null"},"excluded_coins":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"result.excluded_coins.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Excluded Coins","uniqueKey":"result.excluded_coins.oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Excluded Coins","uniqueKey":"result.excluded_coins.oneOf.1","typeLabel":"null"}],"uniqueKey":"result.excluded_coins","typeLabel":"string[] | null"},"on_paid_url":{"oneOf":[{"type":"string","title":"On Paid Url","uniqueKey":"result.on_paid_url.oneOf.0","typeLabel":"string"},{"type":"null","title":"On Paid Url","uniqueKey":"result.on_paid_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"result.on_paid_url","typeLabel":"string | null"},"on_cancel_url":{"oneOf":[{"type":"string","title":"On Cancel Url","uniqueKey":"result.on_cancel_url.oneOf.0","typeLabel":"string"},{"type":"null","title":"On Cancel Url","uniqueKey":"result.on_cancel_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"result.on_cancel_url","typeLabel":"string | null"},"notify_url":{"oneOf":[{"type":"string","title":"Notify Url","uniqueKey":"result.notify_url.oneOf.0","typeLabel":"string"},{"type":"null","title":"Notify Url","uniqueKey":"result.notify_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"result.notify_url","typeLabel":"string | null"},"price_modifier":{"oneOf":[{"type":"number","title":"Price Modifier","uniqueKey":"result.price_modifier.oneOf.0","typeLabel":"number"},{"type":"null","title":"Price Modifier","uniqueKey":"result.price_modifier.oneOf.1","typeLabel":"null"}],"uniqueKey":"result.price_modifier","typeLabel":"number | null"},"original_amount":{"oneOf":[{"type":"number","title":"Original Amount","description":"Set only when price_modifier was applied.","uniqueKey":"result.original_amount.oneOf.0","typeLabel":"number"},{"type":"null","title":"Original Amount","description":"Set only when price_modifier was applied.","uniqueKey":"result.original_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"result.original_amount","typeLabel":"number | null"},"payer_info":{"oneOf":[{"type":"object","title":"Payer Info","uniqueKey":"result.payer_info.oneOf.0","typeLabel":"Payer Info · object"},{"type":"null","title":"Payer Info","uniqueKey":"result.payer_info.oneOf.1","typeLabel":"null"}],"uniqueKey":"result.payer_info","typeLabel":"Payer Info · object | null"},"permanent_address_id":{"oneOf":[{"type":"string","title":"Permanent Address Id","description":"Set only on deposit invoices auto-created from a permanent address.","uniqueKey":"result.permanent_address_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Permanent Address Id","description":"Set only on deposit invoices auto-created from a permanent address.","uniqueKey":"result.permanent_address_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"result.permanent_address_id","typeLabel":"string | null"},"user_id":{"oneOf":[{"type":"string","title":"User Id","description":"Set only on deposit invoices auto-created from a permanent address (copied from the address).","uniqueKey":"result.user_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"User Id","description":"Set only on deposit invoices auto-created from a permanent address (copied from the address).","uniqueKey":"result.user_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"result.user_id","typeLabel":"string | null"},"received_amount":{"oneOf":[{"type":"number","title":"Received Amount","description":"Cumulative crypto amount actually received on-chain.","uniqueKey":"result.received_amount.oneOf.0","typeLabel":"number"},{"type":"null","title":"Received Amount","description":"Cumulative crypto amount actually received on-chain.","uniqueKey":"result.received_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"result.received_amount","typeLabel":"number | null"},"txid":{"oneOf":[{"type":"string","title":"Txid","description":"Hash of the (last) transaction that contributed to this invoice. Set after a successful on-chain payment.","uniqueKey":"result.txid.oneOf.0","typeLabel":"string"},{"type":"null","title":"Txid","description":"Hash of the (last) transaction that contributed to this invoice. Set after a successful on-chain payment.","uniqueKey":"result.txid.oneOf.1","typeLabel":"null"}],"uniqueKey":"result.txid","typeLabel":"string | null"},"payment_url":{"oneOf":[{"type":"string","title":"Payment Url","uniqueKey":"result.payment_url.oneOf.0","typeLabel":"string"},{"type":"null","title":"Payment Url","uniqueKey":"result.payment_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"result.payment_url","typeLabel":"string | null"},"webhook_format":{"oneOf":[{"type":"string","title":"Webhook Format","uniqueKey":"result.webhook_format.oneOf.0","typeLabel":"string"},{"type":"null","title":"Webhook Format","uniqueKey":"result.webhook_format.oneOf.1","typeLabel":"null"}],"uniqueKey":"result.webhook_format","typeLabel":"string | null"},"created_at":{"oneOf":[{"type":"integer","title":"Created At","description":"Unix timestamp (seconds).","uniqueKey":"result.created_at.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Created At","description":"Unix timestamp (seconds).","uniqueKey":"result.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"result.created_at","typeLabel":"integer | null"},"processed_at":{"oneOf":[{"type":"integer","title":"Processed At","description":"Unix timestamp when the invoice transitioned to a paid status (success / partially_paid / paid_over).","uniqueKey":"result.processed_at.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Processed At","description":"Unix timestamp when the invoice transitioned to a paid status (success / partially_paid / paid_over).","uniqueKey":"result.processed_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"result.processed_at","typeLabel":"integer | null"}},"required":["order_id"],"title":"Invoice","type":"object","isRequired":true,"uniqueKey":"result","typeLabel":"Invoice · object"}},"required":["ok","result"],"title":"InvoiceEnvelope","type":"object","uniqueKey":"","typeLabel":"InvoiceEnvelope · object"},"examples":{"Example":{"title":"Example","value":{"ok":true,"result":{"accepted_coins":["usdt_tron","usdc_eth"],"address_from":null,"address_to":"TXk2Y5...redacted","amount":49.5,"asset":"usdt_tron","billing_type":"fiat","created_at":1763398800,"description":"1 month subscription","excluded_coins":null,"expires_at":1763400600,"extra":"order-12345","fee_bearer":"merchant","fiat_amount":50,"fiat_currency":"USD","initial_amount":49.5,"initial_asset":"usdt_tron","initial_fiat_amount":50,"metadata":{"customer_id":"u_42"},"notify_url":"https://shop.example.com/webhook/paw","on_cancel_url":"https://shop.example.com/cancel","on_paid_url":"https://shop.example.com/thanks","order_id":"65f1c3a4e8b1c2d3a4b5c6d7","original_amount":50,"payer_info":null,"payment_url":"https://pawpayments.com/checkout/f2c8a3d1-4b7e-4f8a-9c1d-2e3b4a5c6d7e","permanent_address_id":null,"price_modifier":-1,"processed_at":null,"received_amount":0,"status":"created","title":"Premium plan","txid":null,"type":"token","underpay_tolerance":2.5,"user_id":null}}}},"exampleType":"generated"}},"exampleType":"generated"},"61b206b0-c571-46af-b84a-d9cda0c73635":{"description":"Bad Request","content":{"application/json":{"schema":{"example":{"error":{"code":"VALIDATION_ERROR","details":[{"field":"amount","message":"Field required"}],"message":"Validation failed"},"ok":false},"properties":{"ok":{"const":false,"title":"Ok","type":"boolean","isRequired":true,"uniqueKey":"ok","typeLabel":"boolean"},"error":{"properties":{"code":{"description":"Machine-readable error code (e.g. NOT_FOUND, VALIDATION_ERROR).","title":"Code","type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"title":"Message","type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{"title":"Details","description":"Optional context. For VALIDATION_ERROR contains a list of {field, message}.","uniqueKey":"error.details.oneOf.0","typeLabel":"any"},{"type":"null","title":"Details","description":"Optional context. For VALIDATION_ERROR contains a list of {field, message}.","uniqueKey":"error.details.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details","typeLabel":"any | null"}},"required":["code","message"],"title":"ErrorBody","type":"object","isRequired":true,"uniqueKey":"error","typeLabel":"ErrorBody · object"}},"required":["ok","error"],"title":"ErrorEnvelope","type":"object","uniqueKey":"","typeLabel":"ErrorEnvelope · object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"VALIDATION_ERROR","details":[{"field":"amount","message":"Field required"}],"message":"Validation failed"},"ok":false}}},"exampleType":"generated"}},"exampleType":"generated"},"e2e8f923-7252-4314-a2a8-58edc751081f":{"description":"Unauthorized","content":{"application/json":{"schema":{"example":{"error":{"code":"VALIDATION_ERROR","details":[{"field":"amount","message":"Field required"}],"message":"Validation failed"},"ok":false},"properties":{"ok":{"const":false,"title":"Ok","type":"boolean","isRequired":true,"uniqueKey":"ok","typeLabel":"boolean"},"error":{"properties":{"code":{"description":"Machine-readable error code (e.g. NOT_FOUND, VALIDATION_ERROR).","title":"Code","type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"title":"Message","type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{"title":"Details","description":"Optional context. For VALIDATION_ERROR contains a list of {field, message}.","uniqueKey":"error.details.oneOf.0","typeLabel":"any"},{"type":"null","title":"Details","description":"Optional context. For VALIDATION_ERROR contains a list of {field, message}.","uniqueKey":"error.details.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details","typeLabel":"any | null"}},"required":["code","message"],"title":"ErrorBody","type":"object","isRequired":true,"uniqueKey":"error","typeLabel":"ErrorBody · object"}},"required":["ok","error"],"title":"ErrorEnvelope","type":"object","uniqueKey":"","typeLabel":"ErrorEnvelope · object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"VALIDATION_ERROR","details":[{"field":"amount","message":"Field required"}],"message":"Validation failed"},"ok":false}}},"exampleType":"generated"}},"exampleType":"generated"},"5237538d-8e26-4d26-a08b-6f4b9f17fba7":{"description":"Not Found","content":{"application/json":{"schema":{"example":{"error":{"code":"VALIDATION_ERROR","details":[{"field":"amount","message":"Field required"}],"message":"Validation failed"},"ok":false},"properties":{"ok":{"const":false,"title":"Ok","type":"boolean","isRequired":true,"uniqueKey":"ok","typeLabel":"boolean"},"error":{"properties":{"code":{"description":"Machine-readable error code (e.g. NOT_FOUND, VALIDATION_ERROR).","title":"Code","type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"title":"Message","type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{"title":"Details","description":"Optional context. For VALIDATION_ERROR contains a list of {field, message}.","uniqueKey":"error.details.oneOf.0","typeLabel":"any"},{"type":"null","title":"Details","description":"Optional context. For VALIDATION_ERROR contains a list of {field, message}.","uniqueKey":"error.details.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details","typeLabel":"any | null"}},"required":["code","message"],"title":"ErrorBody","type":"object","isRequired":true,"uniqueKey":"error","typeLabel":"ErrorBody · object"}},"required":["ok","error"],"title":"ErrorEnvelope","type":"object","uniqueKey":"","typeLabel":"ErrorEnvelope · object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"VALIDATION_ERROR","details":[{"field":"amount","message":"Field required"}],"message":"Validation failed"},"ok":false}}},"exampleType":"generated"}},"exampleType":"generated"},"30a46752-68a0-45f0-956e-d28afa01b85a":{"description":"Unprocessable Content","content":{"application/json":{"schema":{"example":{"error":{"code":"VALIDATION_ERROR","details":[{"field":"amount","message":"Field required"}],"message":"Validation failed"},"ok":false},"properties":{"ok":{"const":false,"title":"Ok","type":"boolean","isRequired":true,"uniqueKey":"ok","typeLabel":"boolean"},"error":{"properties":{"code":{"description":"Machine-readable error code (e.g. NOT_FOUND, VALIDATION_ERROR).","title":"Code","type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"title":"Message","type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{"title":"Details","description":"Optional context. For VALIDATION_ERROR contains a list of {field, message}.","uniqueKey":"error.details.oneOf.0","typeLabel":"any"},{"type":"null","title":"Details","description":"Optional context. For VALIDATION_ERROR contains a list of {field, message}.","uniqueKey":"error.details.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details","typeLabel":"any | null"}},"required":["code","message"],"title":"ErrorBody","type":"object","isRequired":true,"uniqueKey":"error","typeLabel":"ErrorBody · object"}},"required":["ok","error"],"title":"ErrorEnvelope","type":"object","uniqueKey":"","typeLabel":"ErrorEnvelope · object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"VALIDATION_ERROR","details":[{"field":"amount","message":"Field required"}],"message":"Validation failed"},"ok":false}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"7fe6fa50-6efa-4362-986f-7c08b1521f52":{"ApiKeyAuth":{"type":"apiKey","name":"x-api-key","in":"header","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"67ba0a1a-6bda-4cd2-867f-8a352a5d97f3":{"url":"https://api.pawpayments.com","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","name":"x-api-key","in":"header","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":"pawpaymentsinc","siteName":"PawPayments API","title":"Create an invoice - PawPayments API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-05T20:49:08.915Z","originalFileLocation":"api-reference/invoices/create-an-invoice.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=\"Creates a new invoice. If asset is omitted, the customer picks the currency on the hosted checkout (the deposit address is allocated only after the choice is made).\">\u003cmeta data-mint-head name=\"application-name\" content=\"PawPayments 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/pawpaymentsinc/MC7gd2QKlNekXMRK/_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/pawpaymentsinc/MC7gd2QKlNekXMRK/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/pawpaymentsinc/MC7gd2QKlNekXMRK/_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/pawpaymentsinc/MC7gd2QKlNekXMRK/_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/pawpaymentsinc/MC7gd2QKlNekXMRK/_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/pawpaymentsinc/MC7gd2QKlNekXMRK/_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/pawpaymentsinc/MC7gd2QKlNekXMRK/_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/pawpaymentsinc/MC7gd2QKlNekXMRK/_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/pawpaymentsinc/MC7gd2QKlNekXMRK/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create an invoice - PawPayments API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Creates a new invoice. If asset is omitted, the customer picks the currency on the hosted checkout (the deposit address is allocated only after the choice is made).\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"PawPayments API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.pawpayments.com/api-reference/invoices/create-an-invoice\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://pawpaymentsinc.mintlify.site/_mintlify/api/og/v2?division=Invoices\u0026amp;title=Create+an+invoice\u0026amp;description=Creates+a+new+invoice.+If+%60asset%60+is+omitted%2C+the+customer+picks+the+currency+on+the+hosted+checkout+%28the+deposit+address+is+allocated+only+after+the+choice+is+\u0026amp;theme=e8ae6fe84fd0496427904623\u0026amp;signature=0a2e64d63c5dca5fb88dc942c2c79eead0a4e8e596e4fb6356be11fcf2cb0ade\">\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 invoice - PawPayments API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Creates a new invoice. If asset is omitted, the customer picks the currency on the hosted checkout (the deposit address is allocated only after the choice is made).\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://pawpaymentsinc.mintlify.site/_mintlify/api/og/v2?division=Invoices\u0026amp;title=Create+an+invoice\u0026amp;description=Creates+a+new+invoice.+If+%60asset%60+is+omitted%2C+the+customer+picks+the+currency+on+the+hosted+checkout+%28the+deposit+address+is+allocated+only+after+the+choice+is+\u0026amp;theme=e8ae6fe84fd0496427904623\u0026amp;signature=0a2e64d63c5dca5fb88dc942c2c79eead0a4e8e596e4fb6356be11fcf2cb0ade\">\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/pawpaymentsinc/MC7gd2QKlNekXMRK/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"PawPayments API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#6366F1\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.pawpayments.com/api-reference/invoices/create-an-invoice\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/invoices/create-an-invoice.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.pawpayments.com/#organization\",\"name\":\"PawPayments API\",\"url\":\"https://docs.pawpayments.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/pawpaymentsinc/GvUEHrxVBBZGqu1B/logo/light.png?fit=max\u0026auto=format\u0026n=GvUEHrxVBBZGqu1B\u0026q=85\u0026s=e63c9c4d933201f4ef804ee6b424f0df\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.pawpayments.com#website\",\"name\":\"PawPayments API\",\"url\":\"https://docs.pawpayments.com\",\"publisher\":{\"@id\":\"https://docs.pawpayments.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.pawpayments.com/api-reference/invoices/create-an-invoice#webpage\",\"url\":\"https://docs.pawpayments.com/api-reference/invoices/create-an-invoice\",\"name\":\"Create an invoice\",\"description\":\"Creates a new invoice. If asset is omitted, the customer picks the currency on the hosted checkout (the deposit address is allocated only after the choice is made).\",\"dateModified\":\"2026-11-05T20:49:08.915Z\",\"isPartOf\":{\"@id\":\"https://docs.pawpayments.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.pawpayments.com/api-reference/invoices/create-an-invoice#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.pawpayments.com/api-reference/invoices/create-an-invoice#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Invoices\",\"item\":\"https://docs.pawpayments.com/api-reference/invoices/list-invoices\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create an invoice\",\"item\":\"https://docs.pawpayments.com/api-reference/invoices/create-an-invoice\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.pawpayments.com/api-reference/invoices/create-an-invoice#apireference\",\"headline\":\"Create an invoice\",\"name\":\"Create an invoice\",\"description\":\"Creates a new invoice. If asset is omitted, the customer picks the currency on the hosted checkout (the deposit address is allocated only after the choice is made).\",\"url\":\"https://docs.pawpayments.com/api-reference/invoices/create-an-invoice\",\"mainEntityOfPage\":{\"@id\":\"https://docs.pawpayments.com/api-reference/invoices/create-an-invoice#webpage\"},\"dateModified\":\"2026-11-05T20:49:08.915Z\",\"publisher\":{\"@id\":\"https://docs.pawpayments.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.pawpayments.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"PawPayments API\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"PawPayments API\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/invoices/create-an-invoice.md","siteName":"PawPayments API","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/overview"}]},{"tab":"API Reference","groups":[{"group":"Catalog","pages":[{"title":"List supported assets","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/assets","href":"/api-reference/catalog/list-supported-assets"},{"title":"Get current exchange rates from cache","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/rates","href":"/api-reference/catalog/get-current-exchange-rates-from-cache"}]},{"group":"Merchant","pages":[{"title":"Get the merchant's balance summary in USD","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/balance","href":"/api-reference/merchant/get-the-merchants-balance-summary-in-usd"},{"title":"Unified income/payout/refund feed","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/ledger","href":"/api-reference/merchant/unified-incomepayoutrefund-feed"}]},{"group":"Invoices","pages":[{"title":"List invoices","description":"Returns a paginated, filterable list of invoices for the authenticated merchant. Supports filtering by status, asset, date range and a list of explicit ids via `order_ids`.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/invoices","href":"/api-reference/invoices/list-invoices"},{"title":"Create an invoice","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/invoices","href":"/api-reference/invoices/create-an-invoice"},{"title":"Get an invoice by id","description":"","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/invoices/{invoice_id}","href":"/api-reference/invoices/get-an-invoice-by-id"},{"title":"Refund a flagged payment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/invoices/{invoice_id}/refund","href":"/api-reference/invoices/refund-a-flagged-payment"},{"title":"Resend the merchant webhook for this invoice","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/invoices/{invoice_id}/notify","href":"/api-reference/invoices/resend-the-merchant-webhook-for-this-invoice"}]},{"group":"Sandbox","pages":[{"title":"Simulate a payment on a sandbox invoice","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/invoices/{invoice_id}/simulate","href":"/api-reference/sandbox/simulate-a-payment-on-a-sandbox-invoice"}]},{"group":"Payouts","pages":[{"title":"List payouts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/payouts","href":"/api-reference/payouts/list-payouts"},{"title":"Create a payout","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/payouts","href":"/api-reference/payouts/create-a-payout"},{"title":"Create a batch of up to 200 payouts. Per-item failures are reported individually","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/payouts/batch","href":"/api-reference/payouts/create-a-batch-of-up-to-200-payouts-per-item-failures-are-reported-individually"},{"title":"Get a payout by id","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/payouts/{payout_id}","href":"/api-reference/payouts/get-a-payout-by-id"}]},{"group":"Notifications","pages":[{"title":"List webhook delivery attempts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/notifications","href":"/api-reference/notifications/list-webhook-delivery-attempts"},{"title":"Send a test webhook to either `url` from the body or the merchant's callback URL","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/notifications/test","href":"/api-reference/notifications/send-a-test-webhook-to-either-`url`-from-the-body-or-the-merchants-callback-url"}]},{"group":"Permanent addresses","pages":[{"title":"List permanent deposit addresses","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/permanent","href":"/api-reference/permanent-addresses/list-permanent-deposit-addresses"},{"title":"Get-or-create a permanent deposit address","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v2/permanent","href":"/api-reference/permanent-addresses/get-or-create-a-permanent-deposit-address"},{"title":"Get a permanent address by id","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v2/permanent/{address_id}","href":"/api-reference/permanent-addresses/get-a-permanent-address-by-id"},{"title":"Deactivate a permanent address","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v2/permanent/{address_id}","href":"/api-reference/permanent-addresses/deactivate-a-permanent-address"}]}]}]},"basePath":"","title":"Create an invoice - PawPayments API","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","CodeSnippet-D_HwgQO_.js","getApiPlaygroundDisplay-CmCoerhe.js","Page-CVJ-f_k1.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}