Creates a generic developer payment request. Optional coupon_code applies a shop-wide coupon to the free value total; product/variant-scoped coupons return 422 VALIDATION_ERROR with error.subcode=coupon_requires_products, and coupons restricted to payment methods return error.subcode=coupon_gateway_restricted; both require /dev/v1/orders. Rejected coupons create no invoice. This endpoint does not create fulfillable product delivery. Use /dev/v1/orders when you need product line items and Shoppex fulfillment. If webhook is provided, the response includes webhook_secret once; use it to verify the order:paid callback for this specific payment/invoice after the payment reaches COMPLETED. For gateway=AUTHORIZENET, Shoppex also creates the provider session and returns checkout_url plus session_id so the payment can complete automatically through the provider webhook flow. For merchant crypto providers (OXAPAY, CRYPTOMUS, NOWPAYMENTS), pass crypto_gateway to return a hosted checkout URL that opens the concrete coin or network directly. Native crypto uses the shop’s non-custodial wallet when crypto_gateway=BITCOIN|LITECOIN|SOLANA|USDT_SOL|USDC_SOL is requested and a native wallet is active for that chain; send gateway=NATIVE_CRYPTO to require that path and fail if it is not configured. Sending crypto_gateway without gateway starts a crypto session on the shop’s active native wallet or connected crypto provider and fails when neither is configured. A payment that a coupon makes free opens no provider session, so these wallet and provider checks do not apply to it. Unsupported gateway values return a validation error and never fall back to another provider. All crypto payments use the shop’s own accounts; Shoppex-managed white-label crypto has been removed.
Unit price in currency. The total (value × quantity) is rounded half up to 2 decimals and must stay below 90,071,992,547,409.92 in a two-decimal currency; a larger total is refused with 422 VALIDATION_ERROR.
ISO 4217 code. Currencies without a minor unit (JPY, HUF, ISK, KRW) are refused with 422 VALIDATION_ERROR, subcode errors.checkout.currency_not_supported.
Shop-wide coupon applied to value × quantity. Product/variant-scoped coupons require POST /dev/v1/orders; refusals return 422 VALIDATION_ERROR with a coupon_* subcode.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Shoppex","colors":{"primary":"#7C3AED","light":"#A78BFA","dark":"#6D28D9"},"logo":{"light":"https://mintcdn.com/shoppex/-b-8YcG0h9UQ6CtI/logo/light.svg?fit=max\u0026auto=format\u0026n=-b-8YcG0h9UQ6CtI\u0026q=85\u0026s=f9f78c42d17f9c45132fbd41cfdf401b","dark":"https://mintcdn.com/shoppex/-b-8YcG0h9UQ6CtI/logo/dark.svg?fit=max\u0026auto=format\u0026n=-b-8YcG0h9UQ6CtI\u0026q=85\u0026s=fff5c87a9643e76fda746d99e4c17801"},"favicon":"https://mintcdn.com/shoppex/u3ztnB0b9rxdxJkJ/favicon.svg?fit=max\u0026auto=format\u0026n=u3ztnB0b9rxdxJkJ\u0026q=85\u0026s=2fd07ab5131df2b2ca66d80a48d54ed5","api":{"playground":{"display":"interactive"},"examples":{"languages":["curl","javascript","python","php","go"]},"mdx":{"auth":{"method":"bearer","name":"Authorization"},"server":"https://api.shoppex.io"}},"appearance":{"default":"system","strict":false},"navbar":{"primary":{"type":"button","label":"Dashboard","href":"https://dashboard.shoppex.io"}},"footer":{"socials":{"github":"https://github.com/ShoppexIO"}},"search":{"prompt":"Search Shoppex docs..."},"fonts":{"heading":{"family":"Geist","weight":700},"body":{"family":"Geist"}},"styling":{"codeblocks":"system","latex":true},"contextual":{"options":["copy","view","chatgpt","claude","cursor","vscode"],"display":"header"},"metadata":{"timestamp":false},"navigation":{"global":{"anchors":[{"anchor":"Discord","icon":"discord","href":"https://discord.gg/VjrptT6Nvx"},{"anchor":"Telegram","icon":"telegram","href":"https://t.me/shoppexhq"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"shoppex","hasAudioNarration":false,"actualSubdomain":"shoppex","customDomains":["docs.shoppex.io"],"gitSource":{"type":"github","owner":"shoppexio","repo":"shoppex","deployBranch":"main","contentDirectory":"apps/docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adba09e5c4337b0661ccc1b","collectionId":"7f09c23d-658e-4c53-838c-9a738db26171","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adba09e5c4337b0661ccc1b"},"entitlements":{},"buildId":"6adba242962377c5727eeada","clientVersion":"0.0.3964","searchFilterCounts":[{"language":"default","tag":"API reference","count":311},{"language":"default","tag":"Products","count":45},{"language":"default","tag":"Developers","count":42},{"language":"default","tag":"Telegram","count":31},{"language":"default","tag":"Guides","count":21},{"language":"default","tag":"Store","count":20},{"language":"default","tag":"Affiliates","count":18},{"language":"default","tag":"Email Marketing","count":17},{"language":"default","tag":"Themes","count":16},{"language":"default","tag":"Workflows","count":16}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"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":"editor-v7-file-tree","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":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"editor-nav-generations","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":"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":"editor-agent-model-picker","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":"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}],"isAtlas":false,"googleFontsInlined":true},"customCss":[],"page":{"pagePath":"api-reference/payments/create-payment","slug":"/api-reference/payments/create-payment","pageMetadata":{"title":"Create payment","description":"Creates a generic developer payment request. Optional `coupon_code` applies a shop-wide coupon to the free value total; product/variant-scoped coupons return 422 `VALIDATION_ERROR` with `error.subcode=coupon_requires_products`, and coupons restricted to payment methods return `error.subcode=coupon_gateway_restricted`; both require `/dev/v1/orders`. Rejected coupons create no invoice. This endpoint does not create fulfillable product delivery. Use `/dev/v1/orders` when you need product line items and Shoppex fulfillment. If `webhook` is provided, the response includes `webhook_secret` once; use it to verify the `order:paid` callback for this specific payment/invoice after the payment reaches `COMPLETED`. For `gateway=AUTHORIZENET`, Shoppex also creates the provider session and returns `checkout_url` plus `session_id` so the payment can complete automatically through the provider webhook flow. For merchant crypto providers (`OXAPAY`, `CRYPTOMUS`, `NOWPAYMENTS`), pass `crypto_gateway` to return a hosted checkout URL that opens the concrete coin or network directly. Native crypto uses the shop's non-custodial wallet when `crypto_gateway=BITCOIN|LITECOIN|SOLANA|USDT_SOL|USDC_SOL` is requested and a native wallet is active for that chain; send `gateway=NATIVE_CRYPTO` to require that path and fail if it is not configured. Sending `crypto_gateway` without `gateway` starts a crypto session on the shop's active native wallet or connected crypto provider and fails when neither is configured. A payment that a coupon makes free opens no provider session, so these wallet and provider checks do not apply to it. Unsupported gateway values return a validation error and never fall back to another provider. All crypto payments use the shop's own accounts; Shoppex-managed white-label crypto has been removed.","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/payments","href":"/api-reference/payments/create-payment","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 generic developer payment request. Optional \", _jsx(_components.code, {\n children: \"coupon_code\"\n }), \" applies a shop-wide coupon to the free value total; product/variant-scoped coupons return 422 \", _jsx(_components.code, {\n children: \"VALIDATION_ERROR\"\n }), \" with \", _jsx(_components.code, {\n children: \"error.subcode=coupon_requires_products\"\n }), \", and coupons restricted to payment methods return \", _jsx(_components.code, {\n children: \"error.subcode=coupon_gateway_restricted\"\n }), \"; both require \", _jsx(_components.code, {\n children: \"/dev/v1/orders\"\n }), \". Rejected coupons create no invoice. This endpoint does not create fulfillable product delivery. Use \", _jsx(_components.code, {\n children: \"/dev/v1/orders\"\n }), \" when you need product line items and Shoppex fulfillment. If \", _jsx(_components.code, {\n children: \"webhook\"\n }), \" is provided, the response includes \", _jsx(_components.code, {\n children: \"webhook_secret\"\n }), \" once; use it to verify the \", _jsx(_components.code, {\n children: \"order:paid\"\n }), \" callback for this specific payment/invoice after the payment reaches \", _jsx(_components.code, {\n children: \"COMPLETED\"\n }), \". For \", _jsx(_components.code, {\n children: \"gateway=AUTHORIZENET\"\n }), \", Shoppex also creates the provider session and returns \", _jsx(_components.code, {\n children: \"checkout_url\"\n }), \" plus \", _jsx(_components.code, {\n children: \"session_id\"\n }), \" so the payment can complete automatically through the provider webhook flow. For merchant crypto providers (\", _jsx(_components.code, {\n children: \"OXAPAY\"\n }), \", \", _jsx(_components.code, {\n children: \"CRYPTOMUS\"\n }), \", \", _jsx(_components.code, {\n children: \"NOWPAYMENTS\"\n }), \"), pass \", _jsx(_components.code, {\n children: \"crypto_gateway\"\n }), \" to return a hosted checkout URL that opens the concrete coin or network directly. Native crypto uses the shop’s non-custodial wallet when \", _jsx(_components.code, {\n children: \"crypto_gateway=BITCOIN|LITECOIN|SOLANA|USDT_SOL|USDC_SOL\"\n }), \" is requested and a native wallet is active for that chain; send \", _jsx(_components.code, {\n children: \"gateway=NATIVE_CRYPTO\"\n }), \" to require that path and fail if it is not configured. Sending \", _jsx(_components.code, {\n children: \"crypto_gateway\"\n }), \" without \", _jsx(_components.code, {\n children: \"gateway\"\n }), \" starts a crypto session on the shop’s active native wallet or connected crypto provider and fails when neither is configured. A payment that a coupon makes free opens no provider session, so these wallet and provider checks do not apply to it. Unsupported gateway values return a validation error and never fall back to another provider. All crypto payments use the shop’s own accounts; Shoppex-managed white-label crypto has been removed.\"]\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":{"codeStyling":"system","config":{},"pageMetadata":{"title":"Create payment","description":"Creates a generic developer payment request. Optional `coupon_code` applies a shop-wide coupon to the free value total; product/variant-scoped coupons return 422 `VALIDATION_ERROR` with `error.subcode=coupon_requires_products`, and coupons restricted to payment methods return `error.subcode=coupon_gateway_restricted`; both require `/dev/v1/orders`. Rejected coupons create no invoice. This endpoint does not create fulfillable product delivery. Use `/dev/v1/orders` when you need product line items and Shoppex fulfillment. If `webhook` is provided, the response includes `webhook_secret` once; use it to verify the `order:paid` callback for this specific payment/invoice after the payment reaches `COMPLETED`. For `gateway=AUTHORIZENET`, Shoppex also creates the provider session and returns `checkout_url` plus `session_id` so the payment can complete automatically through the provider webhook flow. For merchant crypto providers (`OXAPAY`, `CRYPTOMUS`, `NOWPAYMENTS`), pass `crypto_gateway` to return a hosted checkout URL that opens the concrete coin or network directly. Native crypto uses the shop's non-custodial wallet when `crypto_gateway=BITCOIN|LITECOIN|SOLANA|USDT_SOL|USDC_SOL` is requested and a native wallet is active for that chain; send `gateway=NATIVE_CRYPTO` to require that path and fail if it is not configured. Sending `crypto_gateway` without `gateway` starts a crypto session on the shop's active native wallet or connected crypto provider and fails when neither is configured. A payment that a coupon makes free opens no provider session, so these wallet and provider checks do not apply to it. Unsupported gateway values return a validation error and never fall back to another provider. All crypto payments use the shop's own accounts; Shoppex-managed white-label crypto has been removed.","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/payments","href":"/api-reference/payments/create-payment","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"postDevV1Payments","summary":"Create payment","description":"Creates a generic developer payment request. Optional `coupon_code` applies a shop-wide coupon to the free value total; product/variant-scoped coupons return 422 `VALIDATION_ERROR` with `error.subcode=coupon_requires_products`, and coupons restricted to payment methods return `error.subcode=coupon_gateway_restricted`; both require `/dev/v1/orders`. Rejected coupons create no invoice. This endpoint does not create fulfillable product delivery. Use `/dev/v1/orders` when you need product line items and Shoppex fulfillment. If `webhook` is provided, the response includes `webhook_secret` once; use it to verify the `order:paid` callback for this specific payment/invoice after the payment reaches `COMPLETED`. For `gateway=AUTHORIZENET`, Shoppex also creates the provider session and returns `checkout_url` plus `session_id` so the payment can complete automatically through the provider webhook flow. For merchant crypto providers (`OXAPAY`, `CRYPTOMUS`, `NOWPAYMENTS`), pass `crypto_gateway` to return a hosted checkout URL that opens the concrete coin or network directly. Native crypto uses the shop's non-custodial wallet when `crypto_gateway=BITCOIN|LITECOIN|SOLANA|USDT_SOL|USDC_SOL` is requested and a native wallet is active for that chain; send `gateway=NATIVE_CRYPTO` to require that path and fail if it is not configured. Sending `crypto_gateway` without `gateway` starts a crypto session on the shop's active native wallet or connected crypto provider and fails when neither is configured. A payment that a coupon makes free opens no provider session, so these wallet and provider checks do not apply to it. Unsupported gateway values return a validation error and never fall back to another provider. All crypto payments use the shop's own accounts; Shoppex-managed white-label crypto has been removed.","tags":["Payments"],"deprecated":false,"security":["33992d51-3d3e-4e89-b21e-a87c9c7319c8"],"requestBody":"9273d032-f78e-47f0-ab46-2cba895f2bf2","responses":{"201":"e78ba6dd-718d-4f79-892e-3b5157f398d4","401":"e7c81069-a295-43c8-8fd4-ec038915bb4b","403":"feaa609f-1fba-42f5-b045-896e2ed1eb4f","422":"5adad0d4-3aba-44f6-8f66-97d2fb7ba4a9","429":"32f3014e-f499-4276-939d-780a7a8bb4dd","500":"79a5d0b1-390f-4c23-ba66-eb951f4d3ff7","503":"101c9b74-827a-49eb-aeb3-a5e4c6d512b1"},"x-shoppex-effect":"consequential","x-shoppex-replay":"record","method":"post","type":"path","servers":["31af7715-cbea-4b9e-aefa-a60f918a8ad0"],"path":"/dev/v1/payments","baseUrlOptions":["https://api.shoppex.io"],"title":"Create payment","codeSamples":[],"requestExampleLanguages":["bash","javascript","python","php","go"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["title","email","value","currency"],"properties":{"title":{"type":"string","minLength":1,"maxLength":128,"isRequired":true,"uniqueKey":"title","typeLabel":"string"},"email":{"type":"string","format":"email","isRequired":true,"uniqueKey":"email","typeLabel":"string\u003cemail>"},"value":{"type":"number","description":"Unit price in `currency`. The total (value × quantity) is rounded half up to 2 decimals and must stay below 90,071,992,547,409.92 in a two-decimal currency; a larger total is refused with 422 VALIDATION_ERROR.","minimum":0.01,"isRequired":true,"uniqueKey":"value","typeLabel":"number"},"currency":{"type":"string","description":"ISO 4217 code. Currencies without a minor unit (JPY, HUF, ISK, KRW) are refused with 422 VALIDATION_ERROR, subcode `errors.checkout.currency_not_supported`.","minLength":3,"maxLength":3,"isRequired":true,"uniqueKey":"currency","typeLabel":"string"},"quantity":{"type":"number","description":"A whole number up to 2147483647. Other quantities are refused with 422 VALIDATION_ERROR.","minimum":1,"uniqueKey":"quantity","typeLabel":"number"},"coupon_code":{"type":"string","description":"Shop-wide coupon applied to value × quantity. Product/variant-scoped coupons require POST /dev/v1/orders; refusals return 422 VALIDATION_ERROR with a coupon_* subcode.","uniqueKey":"coupon_code","typeLabel":"string"},"gateway":{"type":"string","uniqueKey":"gateway","typeLabel":"string"},"crypto_gateway":{"type":"string","uniqueKey":"crypto_gateway","typeLabel":"string"},"cryptoGateway":{"type":"string","uniqueKey":"cryptoGateway","typeLabel":"string"},"gateways":{"type":"array","items":{"type":"string","uniqueKey":"gateways.items.[INDEX]","typeLabel":"string"},"uniqueKey":"gateways","typeLabel":"string[]"},"confirmations":{"type":"number","minimum":1,"uniqueKey":"confirmations","typeLabel":"number"},"webhook":{"type":"string","uniqueKey":"webhook","typeLabel":"string"},"return_url":{"type":"string","uniqueKey":"return_url","typeLabel":"string"},"cancel_url":{"type":"string","uniqueKey":"cancel_url","typeLabel":"string"},"custom_fields":{"type":"array","items":{"type":"object","additionalProperties":{"type":"object","additionalProperties":true,"uniqueKey":"custom_fields.items.[INDEX].additionalProperties","typeLabel":"object"},"uniqueKey":"custom_fields.items.[INDEX]","typeLabel":"object"},"uniqueKey":"custom_fields","typeLabel":"object[]"},"customFields":{"type":"array","items":{"type":"object","additionalProperties":{"type":"object","additionalProperties":true,"uniqueKey":"customFields.items.[INDEX].additionalProperties","typeLabel":"object"},"uniqueKey":"customFields.items.[INDEX]","typeLabel":"object"},"uniqueKey":"customFields","typeLabel":"object[]"},"product_id":{"type":"string","uniqueKey":"product_id","typeLabel":"string"},"productId":{"type":"string","uniqueKey":"productId","typeLabel":"string"},"items":{"type":"array","items":{"type":"object","additionalProperties":{"type":"object","additionalProperties":true,"uniqueKey":"\\items.items.[INDEX].additionalProperties","typeLabel":"object"},"uniqueKey":"\\items.items.[INDEX]","typeLabel":"object"},"uniqueKey":"\\items","typeLabel":"object[]"},"cart":{"type":"string","uniqueKey":"cart","typeLabel":"string"},"products":{"type":"array","items":{"type":"object","additionalProperties":{"type":"object","additionalProperties":true,"uniqueKey":"products.items.[INDEX].additionalProperties","typeLabel":"object"},"uniqueKey":"products.items.[INDEX]","typeLabel":"object"},"uniqueKey":"products","typeLabel":"object[]"},"customer_id":{"type":"string","uniqueKey":"customer_id","typeLabel":"string"},"fraud_shield":{"type":"object","properties":{"ip":{"type":"string","uniqueKey":"fraud_shield.ip","typeLabel":"string"},"user_agent":{"type":"string","uniqueKey":"fraud_shield.user_agent","typeLabel":"string"},"user_language":{"type":"string","uniqueKey":"fraud_shield.user_language","typeLabel":"string"}},"uniqueKey":"fraud_shield","typeLabel":"object"}},"example":{"title":"Card Payment","email":"[email protected]","value":24.99,"currency":"USD","gateway":"STRIPE","return_url":"https://app.example.com/payments/success","cancel_url":"https://app.example.com/payments/cancelled","webhook":"https://app.example.com/webhooks/payments","white_label":false},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"title":"Card Payment","email":"[email protected]","value":24.99,"currency":"USD","gateway":"STRIPE","return_url":"https://app.example.com/payments/success","cancel_url":"https://app.example.com/payments/cancelled","webhook":"https://app.example.com/webhooks/payments","white_label":false}}},"exampleType":"generated"},"application/x-www-form-urlencoded":{"schema":{"type":"object","required":["title","email","value","currency"],"properties":{"title":{"type":"string","minLength":1,"maxLength":128,"isRequired":true,"uniqueKey":"title","typeLabel":"string"},"email":{"type":"string","format":"email","isRequired":true,"uniqueKey":"email","typeLabel":"string\u003cemail>"},"value":{"type":"number","description":"Unit price in `currency`. The total (value × quantity) is rounded half up to 2 decimals and must stay below 90,071,992,547,409.92 in a two-decimal currency; a larger total is refused with 422 VALIDATION_ERROR.","minimum":0.01,"isRequired":true,"uniqueKey":"value","typeLabel":"number"},"currency":{"type":"string","description":"ISO 4217 code. Currencies without a minor unit (JPY, HUF, ISK, KRW) are refused with 422 VALIDATION_ERROR, subcode `errors.checkout.currency_not_supported`.","minLength":3,"maxLength":3,"isRequired":true,"uniqueKey":"currency","typeLabel":"string"},"quantity":{"type":"number","description":"A whole number up to 2147483647. Other quantities are refused with 422 VALIDATION_ERROR.","minimum":1,"uniqueKey":"quantity","typeLabel":"number"},"coupon_code":{"type":"string","description":"Shop-wide coupon applied to value × quantity. Product/variant-scoped coupons require POST /dev/v1/orders; refusals return 422 VALIDATION_ERROR with a coupon_* subcode.","uniqueKey":"coupon_code","typeLabel":"string"},"gateway":{"type":"string","uniqueKey":"gateway","typeLabel":"string"},"crypto_gateway":{"type":"string","uniqueKey":"crypto_gateway","typeLabel":"string"},"cryptoGateway":{"type":"string","uniqueKey":"cryptoGateway","typeLabel":"string"},"gateways":{"type":"array","items":{"type":"string","uniqueKey":"gateways.items.[INDEX]","typeLabel":"string"},"uniqueKey":"gateways","typeLabel":"string[]"},"confirmations":{"type":"number","minimum":1,"uniqueKey":"confirmations","typeLabel":"number"},"webhook":{"type":"string","uniqueKey":"webhook","typeLabel":"string"},"return_url":{"type":"string","uniqueKey":"return_url","typeLabel":"string"},"cancel_url":{"type":"string","uniqueKey":"cancel_url","typeLabel":"string"},"custom_fields":{"type":"array","items":{"type":"object","additionalProperties":{"type":"object","additionalProperties":true,"uniqueKey":"custom_fields.items.[INDEX].additionalProperties","typeLabel":"object"},"uniqueKey":"custom_fields.items.[INDEX]","typeLabel":"object"},"uniqueKey":"custom_fields","typeLabel":"object[]"},"customFields":{"type":"array","items":{"type":"object","additionalProperties":{"type":"object","additionalProperties":true,"uniqueKey":"customFields.items.[INDEX].additionalProperties","typeLabel":"object"},"uniqueKey":"customFields.items.[INDEX]","typeLabel":"object"},"uniqueKey":"customFields","typeLabel":"object[]"},"product_id":{"type":"string","uniqueKey":"product_id","typeLabel":"string"},"productId":{"type":"string","uniqueKey":"productId","typeLabel":"string"},"items":{"type":"array","items":{"type":"object","additionalProperties":{"type":"object","additionalProperties":true,"uniqueKey":"\\items.items.[INDEX].additionalProperties","typeLabel":"object"},"uniqueKey":"\\items.items.[INDEX]","typeLabel":"object"},"uniqueKey":"\\items","typeLabel":"object[]"},"cart":{"type":"string","uniqueKey":"cart","typeLabel":"string"},"products":{"type":"array","items":{"type":"object","additionalProperties":{"type":"object","additionalProperties":true,"uniqueKey":"products.items.[INDEX].additionalProperties","typeLabel":"object"},"uniqueKey":"products.items.[INDEX]","typeLabel":"object"},"uniqueKey":"products","typeLabel":"object[]"},"customer_id":{"type":"string","uniqueKey":"customer_id","typeLabel":"string"},"fraud_shield":{"type":"object","properties":{"ip":{"type":"string","uniqueKey":"fraud_shield.ip","typeLabel":"string"},"user_agent":{"type":"string","uniqueKey":"fraud_shield.user_agent","typeLabel":"string"},"user_language":{"type":"string","uniqueKey":"fraud_shield.user_language","typeLabel":"string"}},"uniqueKey":"fraud_shield","typeLabel":"object"}},"example":{"title":"Card Payment","email":"[email protected]","value":24.99,"currency":"USD","gateway":"STRIPE","return_url":"https://app.example.com/payments/success","cancel_url":"https://app.example.com/payments/cancelled","webhook":"https://app.example.com/webhooks/payments","white_label":false},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"title":"Card Payment","email":"[email protected]","value":24.99,"currency":"USD","gateway":"STRIPE","return_url":"https://app.example.com/payments/success","cancel_url":"https://app.example.com/payments/cancelled","webhook":"https://app.example.com/webhooks/payments","white_label":false}}},"exampleType":"generated"},"multipart/form-data":{"schema":{"type":"object","required":["title","email","value","currency"],"properties":{"title":{"type":"string","minLength":1,"maxLength":128,"isRequired":true,"uniqueKey":"title","typeLabel":"string"},"email":{"type":"string","format":"email","isRequired":true,"uniqueKey":"email","typeLabel":"string\u003cemail>"},"value":{"type":"number","description":"Unit price in `currency`. The total (value × quantity) is rounded half up to 2 decimals and must stay below 90,071,992,547,409.92 in a two-decimal currency; a larger total is refused with 422 VALIDATION_ERROR.","minimum":0.01,"isRequired":true,"uniqueKey":"value","typeLabel":"number"},"currency":{"type":"string","description":"ISO 4217 code. Currencies without a minor unit (JPY, HUF, ISK, KRW) are refused with 422 VALIDATION_ERROR, subcode `errors.checkout.currency_not_supported`.","minLength":3,"maxLength":3,"isRequired":true,"uniqueKey":"currency","typeLabel":"string"},"quantity":{"type":"number","description":"A whole number up to 2147483647. Other quantities are refused with 422 VALIDATION_ERROR.","minimum":1,"uniqueKey":"quantity","typeLabel":"number"},"coupon_code":{"type":"string","description":"Shop-wide coupon applied to value × quantity. Product/variant-scoped coupons require POST /dev/v1/orders; refusals return 422 VALIDATION_ERROR with a coupon_* subcode.","uniqueKey":"coupon_code","typeLabel":"string"},"gateway":{"type":"string","uniqueKey":"gateway","typeLabel":"string"},"crypto_gateway":{"type":"string","uniqueKey":"crypto_gateway","typeLabel":"string"},"cryptoGateway":{"type":"string","uniqueKey":"cryptoGateway","typeLabel":"string"},"gateways":{"type":"array","items":{"type":"string","uniqueKey":"gateways.items.[INDEX]","typeLabel":"string"},"uniqueKey":"gateways","typeLabel":"string[]"},"confirmations":{"type":"number","minimum":1,"uniqueKey":"confirmations","typeLabel":"number"},"webhook":{"type":"string","uniqueKey":"webhook","typeLabel":"string"},"return_url":{"type":"string","uniqueKey":"return_url","typeLabel":"string"},"cancel_url":{"type":"string","uniqueKey":"cancel_url","typeLabel":"string"},"custom_fields":{"type":"array","items":{"type":"object","additionalProperties":{"type":"object","additionalProperties":true,"uniqueKey":"custom_fields.items.[INDEX].additionalProperties","typeLabel":"object"},"uniqueKey":"custom_fields.items.[INDEX]","typeLabel":"object"},"uniqueKey":"custom_fields","typeLabel":"object[]"},"customFields":{"type":"array","items":{"type":"object","additionalProperties":{"type":"object","additionalProperties":true,"uniqueKey":"customFields.items.[INDEX].additionalProperties","typeLabel":"object"},"uniqueKey":"customFields.items.[INDEX]","typeLabel":"object"},"uniqueKey":"customFields","typeLabel":"object[]"},"product_id":{"type":"string","uniqueKey":"product_id","typeLabel":"string"},"productId":{"type":"string","uniqueKey":"productId","typeLabel":"string"},"items":{"type":"array","items":{"type":"object","additionalProperties":{"type":"object","additionalProperties":true,"uniqueKey":"\\items.items.[INDEX].additionalProperties","typeLabel":"object"},"uniqueKey":"\\items.items.[INDEX]","typeLabel":"object"},"uniqueKey":"\\items","typeLabel":"object[]"},"cart":{"type":"string","uniqueKey":"cart","typeLabel":"string"},"products":{"type":"array","items":{"type":"object","additionalProperties":{"type":"object","additionalProperties":true,"uniqueKey":"products.items.[INDEX].additionalProperties","typeLabel":"object"},"uniqueKey":"products.items.[INDEX]","typeLabel":"object"},"uniqueKey":"products","typeLabel":"object[]"},"customer_id":{"type":"string","uniqueKey":"customer_id","typeLabel":"string"},"fraud_shield":{"type":"object","properties":{"ip":{"type":"string","uniqueKey":"fraud_shield.ip","typeLabel":"string"},"user_agent":{"type":"string","uniqueKey":"fraud_shield.user_agent","typeLabel":"string"},"user_language":{"type":"string","uniqueKey":"fraud_shield.user_language","typeLabel":"string"}},"uniqueKey":"fraud_shield","typeLabel":"object"}},"example":{"title":"Card Payment","email":"[email protected]","value":24.99,"currency":"USD","gateway":"STRIPE","return_url":"https://app.example.com/payments/success","cancel_url":"https://app.example.com/payments/cancelled","webhook":"https://app.example.com/webhooks/payments","white_label":false},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"title":"Card Payment","email":"[email protected]","value":24.99,"currency":"USD","gateway":"STRIPE","return_url":"https://app.example.com/payments/success","cancel_url":"https://app.example.com/payments/cancelled","webhook":"https://app.example.com/webhooks/payments","white_label":false}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"e78ba6dd-718d-4f79-892e-3b5157f398d4":{"description":"Response for status 201","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["id","uniqid","type","shop_id","customer_id","currency","gateway","flow_type","provider_reference","provider_reference_type","blockchain","apm_method","crypto_address","crypto_amount","crypto_received","crypto_uri","crypto_confirmations_needed","crypto_payment_txid","product_id","product_title","product_type","variant_title","quantity","total","total_display","balance_paid_amount","exchange_rate","crypto_exchange_rate","customer_email","custom_fields","is_developer_invoice","developer_title","developer_webhook","developer_return_url","developer_cancel_url","status","items","created_at","updated_at","url","url_branded"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"data.id","typeLabel":"string"},"uniqid":{"type":"string","isRequired":true,"uniqueKey":"data.uniqid","typeLabel":"string"},"type":{"type":"string","isRequired":true,"uniqueKey":"data.type","typeLabel":"string"},"shop_id":{"type":"string","isRequired":true,"uniqueKey":"data.shop_id","typeLabel":"string"},"customer_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.customer_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.customer_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.customer_id","typeLabel":"string | null"},"currency":{"type":"string","isRequired":true,"uniqueKey":"data.currency","typeLabel":"string"},"gateway":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.gateway.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.gateway.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.gateway","typeLabel":"string | null"},"flow_type":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.flow_type.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.flow_type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.flow_type","typeLabel":"string | null"},"provider_reference":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.provider_reference.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.provider_reference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.provider_reference","typeLabel":"string | null"},"provider_reference_type":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.provider_reference_type.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.provider_reference_type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.provider_reference_type","typeLabel":"string | null"},"blockchain":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.blockchain.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.blockchain.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.blockchain","typeLabel":"string | null"},"apm_method":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.apm_method.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.apm_method.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.apm_method","typeLabel":"string | null"},"crypto_address":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.crypto_address.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.crypto_address.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.crypto_address","typeLabel":"string | null"},"crypto_amount":{"type":"number","isRequired":true,"uniqueKey":"data.crypto_amount","typeLabel":"number"},"crypto_received":{"type":"number","isRequired":true,"uniqueKey":"data.crypto_received","typeLabel":"number"},"crypto_uri":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.crypto_uri.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.crypto_uri.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.crypto_uri","typeLabel":"string | null"},"crypto_confirmations_needed":{"type":"number","isRequired":true,"uniqueKey":"data.crypto_confirmations_needed","typeLabel":"number"},"crypto_payment_txid":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.crypto_payment_txid.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.crypto_payment_txid.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.crypto_payment_txid","typeLabel":"string | null"},"product_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.product_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.product_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.product_id","typeLabel":"string | null"},"product_title":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.product_title.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.product_title.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.product_title","typeLabel":"string | null"},"product_type":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.product_type.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.product_type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.product_type","typeLabel":"string | null"},"variant_title":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.variant_title.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.variant_title.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.variant_title","typeLabel":"string | null"},"quantity":{"type":"number","isRequired":true,"uniqueKey":"data.quantity","typeLabel":"number"},"total":{"type":"number","description":"Total in USD. Use total_display for the amount in currency.","isRequired":true,"uniqueKey":"data.total","typeLabel":"number"},"total_display":{"type":"number","description":"Total in the payment currency.","isRequired":true,"uniqueKey":"data.total_display","typeLabel":"number"},"balance_paid_amount":{"type":"number","isRequired":true,"uniqueKey":"data.balance_paid_amount","typeLabel":"number"},"exchange_rate":{"type":"number","isRequired":true,"uniqueKey":"data.exchange_rate","typeLabel":"number"},"crypto_exchange_rate":{"type":"number","isRequired":true,"uniqueKey":"data.crypto_exchange_rate","typeLabel":"number"},"customer_email":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.customer_email.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.customer_email.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.customer_email","typeLabel":"string | null"},"custom_fields":{"oneOf":[{"type":"object","additionalProperties":{"type":"object","additionalProperties":true,"uniqueKey":"data.custom_fields.oneOf.0.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.custom_fields.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"type":"object","additionalProperties":true,"uniqueKey":"data.custom_fields.oneOf.1.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.custom_fields.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.custom_fields","typeLabel":"object | null"},"is_developer_invoice":{"type":"boolean","isRequired":true,"uniqueKey":"data.is_developer_invoice","typeLabel":"boolean"},"developer_title":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.developer_title.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.developer_title.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.developer_title","typeLabel":"string | null"},"developer_webhook":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.developer_webhook.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.developer_webhook.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.developer_webhook","typeLabel":"string | null"},"developer_return_url":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.developer_return_url.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.developer_return_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.developer_return_url","typeLabel":"string | null"},"developer_cancel_url":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.developer_cancel_url.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.developer_cancel_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.developer_cancel_url","typeLabel":"string | null"},"status":{"type":"string","isRequired":true,"uniqueKey":"data.status","typeLabel":"string"},"items":{"type":"array","items":{"type":"object","required":["product_id","product_title","product_type","variant_title","quantity","unit_price","total"],"properties":{"product_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].product_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].product_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].product_id","typeLabel":"string | null"},"product_title":{"type":"string","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].product_title","typeLabel":"string"},"product_type":{"type":"string","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].product_type","typeLabel":"string"},"variant_title":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].variant_title.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].variant_title.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].variant_title","typeLabel":"string | null"},"quantity":{"type":"number","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].quantity","typeLabel":"number"},"unit_price":{"type":"number","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].unit_price","typeLabel":"number"},"total":{"type":"number","isRequired":true,"uniqueKey":"data.\\items.items.[INDEX].total","typeLabel":"number"}},"additionalProperties":true,"uniqueKey":"data.\\items.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.\\items","typeLabel":"object[]"},"created_at":{"type":"number","isRequired":true,"uniqueKey":"data.created_at","typeLabel":"number"},"updated_at":{"type":"number","isRequired":true,"uniqueKey":"data.updated_at","typeLabel":"number"},"url":{"type":"string","isRequired":true,"uniqueKey":"data.url","typeLabel":"string"},"url_branded":{"type":"string","isRequired":true,"uniqueKey":"data.url_branded","typeLabel":"string"},"crypto_gateway":{"type":"string","uniqueKey":"data.crypto_gateway","typeLabel":"string"},"payment_id":{"type":"string","uniqueKey":"data.payment_id","typeLabel":"string"},"expires_at":{"type":"string","uniqueKey":"data.expires_at","typeLabel":"string"},"coupon_id":{"oneOf":[{"type":"string","uniqueKey":"data.coupon_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.coupon_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.coupon_id","typeLabel":"string | null"},"discount":{"type":"number","description":"Coupon discount in USD.","uniqueKey":"data.discount","typeLabel":"number"},"discount_display":{"type":"number","description":"Coupon discount in currency.","uniqueKey":"data.discount_display","typeLabel":"number"},"gateways":{"type":"array","items":{"type":"string","uniqueKey":"data.gateways.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.gateways","typeLabel":"string[]"},"checkout_url":{"type":"string","uniqueKey":"data.checkout_url","typeLabel":"string"},"session_id":{"type":"string","uniqueKey":"data.session_id","typeLabel":"string"},"webhook_secret":{"type":"string","uniqueKey":"data.webhook_secret","typeLabel":"string"},"warnings":{"type":"array","items":{"type":"object","required":["code","field","message"],"properties":{"code":{"type":"string","enum":["subscription_checkout_mismatch"],"isRequired":true,"uniqueKey":"data.warnings.items.[INDEX].code","typeLabel":"enum\u003cstring>"},"field":{"type":"string","isRequired":true,"uniqueKey":"data.warnings.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"data.warnings.items.[INDEX].message","typeLabel":"string"}},"additionalProperties":true,"uniqueKey":"data.warnings.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.warnings","typeLabel":"object[]"}},"additionalProperties":true,"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"additionalProperties":true,"example":{"data":{"uniqid":"33333333-3333-4333-8333-333333333333","url":"https://checkout.shoppex.io/invoice/33333333-3333-4333-8333-333333333333","url_branded":"https://pay.example.com/invoice/33333333-3333-4333-8333-333333333333","total":24.99,"currency":"USD","status":"PENDING","created_at":1711510800}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"uniqid":"33333333-3333-4333-8333-333333333333","url":"https://checkout.shoppex.io/invoice/33333333-3333-4333-8333-333333333333","url_branded":"https://pay.example.com/invoice/33333333-3333-4333-8333-333333333333","total":24.99,"currency":"USD","status":"PENDING","created_at":1711510800}}}},"exampleType":"generated"}},"exampleType":"generated"},"e7c81069-a295-43c8-8fd4-ec038915bb4b":{"description":"Response for status 401","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","doc_url"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"doc_url":{"type":"string","isRequired":true,"uniqueKey":"error.doc_url","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","required":["field","message"],"properties":{"field":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"additionalProperties":true,"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"},"subcode":{"type":"string","uniqueKey":"error.subcode","typeLabel":"string"}},"additionalProperties":true,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"additionalProperties":true,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","doc_url":"\u003cstring>","details":[{"field":"\u003cstring>","message":"\u003cstring>"}],"subcode":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"feaa609f-1fba-42f5-b045-896e2ed1eb4f":{"description":"Response for status 403","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","doc_url"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"doc_url":{"type":"string","isRequired":true,"uniqueKey":"error.doc_url","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","required":["field","message"],"properties":{"field":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"additionalProperties":true,"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"},"subcode":{"type":"string","uniqueKey":"error.subcode","typeLabel":"string"}},"additionalProperties":true,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"additionalProperties":true,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","doc_url":"\u003cstring>","details":[{"field":"\u003cstring>","message":"\u003cstring>"}],"subcode":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"5adad0d4-3aba-44f6-8f66-97d2fb7ba4a9":{"description":"Response for status 422","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","doc_url"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"doc_url":{"type":"string","isRequired":true,"uniqueKey":"error.doc_url","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","required":["field","message"],"properties":{"field":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"additionalProperties":true,"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"},"subcode":{"type":"string","uniqueKey":"error.subcode","typeLabel":"string"}},"additionalProperties":true,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"additionalProperties":true,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","doc_url":"\u003cstring>","details":[{"field":"\u003cstring>","message":"\u003cstring>"}],"subcode":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"32f3014e-f499-4276-939d-780a7a8bb4dd":{"description":"Response for status 429","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","doc_url"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"doc_url":{"type":"string","isRequired":true,"uniqueKey":"error.doc_url","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","required":["field","message"],"properties":{"field":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"additionalProperties":true,"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"},"subcode":{"type":"string","uniqueKey":"error.subcode","typeLabel":"string"}},"additionalProperties":true,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"additionalProperties":true,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","doc_url":"\u003cstring>","details":[{"field":"\u003cstring>","message":"\u003cstring>"}],"subcode":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"79a5d0b1-390f-4c23-ba66-eb951f4d3ff7":{"description":"Response for status 500","content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","doc_url"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.error.message","typeLabel":"string"},"doc_url":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.error.doc_url","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","required":["field","message"],"properties":{"field":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.error.details.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.error.details.items.[INDEX].message","typeLabel":"string"}},"additionalProperties":true,"uniqueKey":"oneOf.0.error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.error.details","typeLabel":"object[]"},"subcode":{"type":"string","uniqueKey":"oneOf.0.error.subcode","typeLabel":"string"}},"additionalProperties":true,"isRequired":true,"uniqueKey":"oneOf.0.error","typeLabel":"object"}},"additionalProperties":true,"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","required":["status","data","error","message","log","env"],"properties":{"status":{"type":"integer","isRequired":true,"uniqueKey":"oneOf.1.status","typeLabel":"integer"},"data":{"oneOf":[{"isRequired":true},{"type":"null","isRequired":true,"uniqueKey":"oneOf.1.data.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.data","typeLabel":"null"},"error":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.error","typeLabel":"string"},"message":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.message.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.1.message.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.message","typeLabel":"string | null"},"log":{"oneOf":[{"isRequired":true},{"type":"null","isRequired":true,"uniqueKey":"oneOf.1.log.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.log","typeLabel":"null"},"env":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.env","typeLabel":"string"}},"additionalProperties":true,"uniqueKey":"oneOf.1","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","doc_url":"\u003cstring>","details":[{"field":"\u003cstring>","message":"\u003cstring>"}],"subcode":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"101c9b74-827a-49eb-aeb3-a5e4c6d512b1":{"description":"Response for status 503","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","doc_url"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"doc_url":{"type":"string","isRequired":true,"uniqueKey":"error.doc_url","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","required":["field","message"],"properties":{"field":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"additionalProperties":true,"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"},"subcode":{"type":"string","uniqueKey":"error.subcode","typeLabel":"string"}},"additionalProperties":true,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"additionalProperties":true,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","doc_url":"\u003cstring>","details":[{"field":"\u003cstring>","message":"\u003cstring>"}],"subcode":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"33992d51-3d3e-4e89-b21e-a87c9c7319c8":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Use your Shoppex API key in the Authorization header.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"31af7715-cbea-4b9e-aefa-a60f918a8ad0":{"url":"https://api.shoppex.io"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Use your Shoppex API key in the Authorization header.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Use your Shoppex API key in the Authorization header.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"shoppex","siteName":"Shoppex","title":"Create payment - Shoppex","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-23T18:00:11.334Z","originalFileLocation":"api-reference/payments/create-payment.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 generic developer payment request. Optional coupon_code applies a shop-wide coupon to the free value total; product/variant-scoped coupons return 422 VALIDATION_ERROR with error.subcode=coupon_requires_products, and coupons restricted to payment methods return error.subcode=coupon_gateway_restricted; both require /dev/v1/orders. Rejected coupons create no invoice. This endpoint does not create fulfillable product delivery. Use /dev/v1/orders when you need product line items and Shoppex fulfillment. If webhook is provided, the response includes webhook_secret once; use it to verify the order:paid callback for this specific payment/invoice after the payment reaches COMPLETED. For gateway=AUTHORIZENET, Shoppex also creates the provider session and returns checkout_url plus session_id so the payment can complete automatically through the provider webhook flow. For merchant crypto providers (OXAPAY, CRYPTOMUS, NOWPAYMENTS), pass crypto_gateway to return a hosted checkout URL that opens the concrete coin or network directly. Native crypto uses the shop\u0026#x27;s non-custodial wallet when crypto_gateway=BITCOIN|LITECOIN|SOLANA|USDT_SOL|USDC_SOL is requested and a native wallet is active for that chain; send gateway=NATIVE_CRYPTO to require that path and fail if it is not configured. Sending crypto_gateway without gateway starts a crypto session on the shop\u0026#x27;s active native wallet or connected crypto provider and fails when neither is configured. A payment that a coupon makes free opens no provider session, so these wallet and provider checks do not apply to it. Unsupported gateway values return a validation error and never fall back to another provider. All crypto payments use the shop\u0026#x27;s own accounts; Shoppex-managed white-label crypto has been removed.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Shoppex\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/shoppex/C3ATQpi32YQbyPeI/_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/shoppex/C3ATQpi32YQbyPeI/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/shoppex/C3ATQpi32YQbyPeI/_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/shoppex/C3ATQpi32YQbyPeI/_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/shoppex/C3ATQpi32YQbyPeI/_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/shoppex/C3ATQpi32YQbyPeI/_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/shoppex/C3ATQpi32YQbyPeI/_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/shoppex/C3ATQpi32YQbyPeI/_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/shoppex/C3ATQpi32YQbyPeI/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create payment - Shoppex\">\u003cmeta data-mint-head property=\"og:description\" content=\"Creates a generic developer payment request. Optional coupon_code applies a shop-wide coupon to the free value total; product/variant-scoped coupons return 422 VALIDATION_ERROR with error.subcode=coupon_requires_products, and coupons restricted to payment methods return error.subcode=coupon_gateway_restricted; both require /dev/v1/orders. Rejected coupons create no invoice. This endpoint does not create fulfillable product delivery. Use /dev/v1/orders when you need product line items and Shoppex fulfillment. If webhook is provided, the response includes webhook_secret once; use it to verify the order:paid callback for this specific payment/invoice after the payment reaches COMPLETED. For gateway=AUTHORIZENET, Shoppex also creates the provider session and returns checkout_url plus session_id so the payment can complete automatically through the provider webhook flow. For merchant crypto providers (OXAPAY, CRYPTOMUS, NOWPAYMENTS), pass crypto_gateway to return a hosted checkout URL that opens the concrete coin or network directly. Native crypto uses the shop\u0026#x27;s non-custodial wallet when crypto_gateway=BITCOIN|LITECOIN|SOLANA|USDT_SOL|USDC_SOL is requested and a native wallet is active for that chain; send gateway=NATIVE_CRYPTO to require that path and fail if it is not configured. Sending crypto_gateway without gateway starts a crypto session on the shop\u0026#x27;s active native wallet or connected crypto provider and fails when neither is configured. A payment that a coupon makes free opens no provider session, so these wallet and provider checks do not apply to it. Unsupported gateway values return a validation error and never fall back to another provider. All crypto payments use the shop\u0026#x27;s own accounts; Shoppex-managed white-label crypto has been removed.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Shoppex\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.shoppex.io/api-reference/payments/create-payment\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://shoppex.mintlify.app/_mintlify/api/og/v2?division=Payments\u0026amp;title=Create+payment\u0026amp;description=Creates+a+generic+developer+payment+request.+Optional+%60coupon_code%60+applies+a+shop-wide+coupon+to+the+free+value+total%3B+product%2Fvariant-scoped+coupons+return+42\u0026amp;theme=da6d0d265cebcb7611011ed9\u0026amp;signature=89bd1a0b07def9c3318ff9d8d5ccf88132abf6cb00f9c56d704f1c4fe5500510\">\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 payment - Shoppex\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Creates a generic developer payment request. Optional coupon_code applies a shop-wide coupon to the free value total; product/variant-scoped coupons return 422 VALIDATION_ERROR with error.subcode=coupon_requires_products, and coupons restricted to payment methods return error.subcode=coupon_gateway_restricted; both require /dev/v1/orders. Rejected coupons create no invoice. This endpoint does not create fulfillable product delivery. Use /dev/v1/orders when you need product line items and Shoppex fulfillment. If webhook is provided, the response includes webhook_secret once; use it to verify the order:paid callback for this specific payment/invoice after the payment reaches COMPLETED. For gateway=AUTHORIZENET, Shoppex also creates the provider session and returns checkout_url plus session_id so the payment can complete automatically through the provider webhook flow. For merchant crypto providers (OXAPAY, CRYPTOMUS, NOWPAYMENTS), pass crypto_gateway to return a hosted checkout URL that opens the concrete coin or network directly. Native crypto uses the shop\u0026#x27;s non-custodial wallet when crypto_gateway=BITCOIN|LITECOIN|SOLANA|USDT_SOL|USDC_SOL is requested and a native wallet is active for that chain; send gateway=NATIVE_CRYPTO to require that path and fail if it is not configured. Sending crypto_gateway without gateway starts a crypto session on the shop\u0026#x27;s active native wallet or connected crypto provider and fails when neither is configured. A payment that a coupon makes free opens no provider session, so these wallet and provider checks do not apply to it. Unsupported gateway values return a validation error and never fall back to another provider. All crypto payments use the shop\u0026#x27;s own accounts; Shoppex-managed white-label crypto has been removed.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://shoppex.mintlify.app/_mintlify/api/og/v2?division=Payments\u0026amp;title=Create+payment\u0026amp;description=Creates+a+generic+developer+payment+request.+Optional+%60coupon_code%60+applies+a+shop-wide+coupon+to+the+free+value+total%3B+product%2Fvariant-scoped+coupons+return+42\u0026amp;theme=da6d0d265cebcb7611011ed9\u0026amp;signature=89bd1a0b07def9c3318ff9d8d5ccf88132abf6cb00f9c56d704f1c4fe5500510\">\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/shoppex/C3ATQpi32YQbyPeI/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Shoppex\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#7C3AED\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.shoppex.io/api-reference/payments/create-payment\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/payments/create-payment.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.shoppex.io/#organization\",\"name\":\"Shoppex\",\"url\":\"https://docs.shoppex.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/shoppex/-b-8YcG0h9UQ6CtI/logo/light.svg?fit=max\u0026auto=format\u0026n=-b-8YcG0h9UQ6CtI\u0026q=85\u0026s=f9f78c42d17f9c45132fbd41cfdf401b\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.shoppex.io#website\",\"name\":\"Shoppex\",\"url\":\"https://docs.shoppex.io\",\"publisher\":{\"@id\":\"https://docs.shoppex.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.shoppex.io/api-reference/payments/create-payment#webpage\",\"url\":\"https://docs.shoppex.io/api-reference/payments/create-payment\",\"name\":\"Create payment\",\"description\":\"Creates a generic developer payment request. Optional coupon_code applies a shop-wide coupon to the free value total; product/variant-scoped coupons return 422 VALIDATION_ERROR with error.subcode=coupon_requires_products, and coupons restricted to payment methods return error.subcode=coupon_gateway_restricted; both require /dev/v1/orders. Rejected coupons create no invoice. This endpoint does not create fulfillable product delivery. Use /dev/v1/orders when you need product line items and Shoppex fulfillment. If webhook is provided, the response includes webhook_secret once; use it to verify the order:paid callback for this specific payment/invoice after the payment reaches COMPLETED. For gateway=AUTHORIZENET, Shoppex also creates the provider session and returns checkout_url plus session_id so the payment can complete automatically through the provider webhook flow. For merchant crypto providers (OXAPAY, CRYPTOMUS, NOWPAYMENTS), pass crypto_gateway to return a hosted checkout URL that opens the concrete coin or network directly. Native crypto uses the shop's non-custodial wallet when crypto_gateway=BITCOIN|LITECOIN|SOLANA|USDT_SOL|USDC_SOL is requested and a native wallet is active for that chain; send gateway=NATIVE_CRYPTO to require that path and fail if it is not configured. Sending crypto_gateway without gateway starts a crypto session on the shop's active native wallet or connected crypto provider and fails when neither is configured. A payment that a coupon makes free opens no provider session, so these wallet and provider checks do not apply to it. Unsupported gateway values return a validation error and never fall back to another provider. All crypto payments use the shop's own accounts; Shoppex-managed white-label crypto has been removed.\",\"dateModified\":\"2026-10-23T18:00:11.334Z\",\"isPartOf\":{\"@id\":\"https://docs.shoppex.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.shoppex.io/api-reference/payments/create-payment#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.shoppex.io/api-reference/payments/create-payment#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Payments\",\"item\":\"https://docs.shoppex.io/api-reference/payments/list-payments\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create payment\",\"item\":\"https://docs.shoppex.io/api-reference/payments/create-payment\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.shoppex.io/api-reference/payments/create-payment#apireference\",\"headline\":\"Create payment\",\"name\":\"Create payment\",\"description\":\"Creates a generic developer payment request. Optional coupon_code applies a shop-wide coupon to the free value total; product/variant-scoped coupons return 422 VALIDATION_ERROR with error.subcode=coupon_requires_products, and coupons restricted to payment methods return error.subcode=coupon_gateway_restricted; both require /dev/v1/orders. Rejected coupons create no invoice. This endpoint does not create fulfillable product delivery. Use /dev/v1/orders when you need product line items and Shoppex fulfillment. If webhook is provided, the response includes webhook_secret once; use it to verify the order:paid callback for this specific payment/invoice after the payment reaches COMPLETED. For gateway=AUTHORIZENET, Shoppex also creates the provider session and returns checkout_url plus session_id so the payment can complete automatically through the provider webhook flow. For merchant crypto providers (OXAPAY, CRYPTOMUS, NOWPAYMENTS), pass crypto_gateway to return a hosted checkout URL that opens the concrete coin or network directly. Native crypto uses the shop's non-custodial wallet when crypto_gateway=BITCOIN|LITECOIN|SOLANA|USDT_SOL|USDC_SOL is requested and a native wallet is active for that chain; send gateway=NATIVE_CRYPTO to require that path and fail if it is not configured. Sending crypto_gateway without gateway starts a crypto session on the shop's active native wallet or connected crypto provider and fails when neither is configured. A payment that a coupon makes free opens no provider session, so these wallet and provider checks do not apply to it. Unsupported gateway values return a validation error and never fall back to another provider. All crypto payments use the shop's own accounts; Shoppex-managed white-label crypto has been removed.\",\"url\":\"https://docs.shoppex.io/api-reference/payments/create-payment\",\"mainEntityOfPage\":{\"@id\":\"https://docs.shoppex.io/api-reference/payments/create-payment#webpage\"},\"dateModified\":\"2026-10-23T18:00:11.334Z\",\"publisher\":{\"@id\":\"https://docs.shoppex.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.shoppex.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Shoppex\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Shoppex","nav":{"global":{"anchors":[{"anchor":"Discord","icon":"discord","href":"https://discord.gg/VjrptT6Nvx"},{"anchor":"Telegram","icon":"telegram","href":"https://t.me/shoppexhq"}]},"tabs":[{"tab":"Guides","icon":"book-open","pages":[{"title":"Guides","href":"/start/quickstart"}]},{"tab":"Storefront","icon":"palette","pages":[{"title":"Storefront","href":"/storefront/themes"}]},{"tab":"Developers","icon":"code","pages":[{"title":"Developers","href":"/developers/quickstart"}]},{"tab":"API reference","icon":"terminal","groups":[{"group":"Account \u0026 Auth","pages":[{"title":"Get current account","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/me","href":"/api-reference/account-\u0026-auth/get-current-account"},{"title":"Get current account capabilities","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/me/capabilities","href":"/api-reference/account-\u0026-auth/get-current-account-capabilities"},{"title":"Get the membership this request acts with","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/me/membership","href":"/api-reference/me/get-the-membership-this-request-acts-with"},{"title":"Start an OAuth authorization (redirects to the dashboard consent page)","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/oauth/authorize","href":"/api-reference/oauth2/start-an-oauth-authorization-redirects-to-the-dashboard-consent-page"},{"title":"Exchange an OAuth code, refresh token or (RFC 8693) access token","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/oauth/token","href":"/api-reference/oauth2/exchange-an-oauth-code-refresh-token-or-rfc-8693-access-token"}]},{"group":"Affiliates","pages":[{"title":"List affiliate customers","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/affiliates/customers","href":"/api-reference/affiliates/list-affiliate-customers"},{"title":"Get affiliate settings","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/affiliates/settings","href":"/api-reference/affiliates/get-affiliate-settings"},{"title":"Update affiliate settings","deprecated":false,"version":null,"openapi":"/openapi.json patch /dev/v1/affiliates/settings","href":"/api-reference/affiliates/update-affiliate-settings"},{"title":"List affiliate customers","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/affiliates/customers","href":"/api-reference/affiliates/list-affiliate-customers"},{"title":"Invite affiliate customer","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/affiliates/customers/{customerId}/invite","href":"/api-reference/affiliates/invite-affiliate-customer"},{"title":"Update affiliate link","deprecated":false,"version":null,"openapi":"/openapi.json patch /dev/v1/affiliates/links/{id}","href":"/api-reference/affiliates/update-affiliate-link"},{"title":"Create affiliate link primary","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/affiliates/links/{id}/primary","href":"/api-reference/affiliates/create-affiliate-link-primary"},{"title":"Update affiliate customer status","deprecated":false,"version":null,"openapi":"/openapi.json patch /dev/v1/affiliates/customers/{customerId}/status","href":"/api-reference/affiliates/update-affiliate-customer-status"},{"title":"Get affiliate customer performance","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/affiliates/customers/{customerId}/performance","href":"/api-reference/affiliates/get-affiliate-customer-performance"},{"title":"List affiliate applications","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/affiliates/applications","href":"/api-reference/affiliates/list-affiliate-applications"},{"title":"Approve affiliate application","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/affiliates/applications/{id}/approve","href":"/api-reference/affiliates/approve-affiliate-application"},{"title":"Reject affiliate application","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/affiliates/applications/{id}/reject","href":"/api-reference/affiliates/reject-affiliate-application"},{"title":"List affiliate payout requests","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/affiliates/payout-requests","href":"/api-reference/affiliates/list-affiliate-payout-requests"},{"title":"Approve payout request (removed)","deprecated":true,"version":null,"openapi":"/openapi.json post /dev/v1/affiliates/payout-requests/{id}/approve","href":"/api-reference/affiliates/approve-payout-request-removed"},{"title":"Force approve affiliate payout request","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/affiliates/payout-requests/{id}/force-approve","href":"/api-reference/affiliates/force-approve-affiliate-payout-request"},{"title":"Reject affiliate payout request","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/affiliates/payout-requests/{id}/reject","href":"/api-reference/affiliates/reject-affiliate-payout-request"},{"title":"Complete affiliate payout request","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/affiliates/payout-requests/{id}/complete","href":"/api-reference/affiliates/complete-affiliate-payout-request"},{"title":"Cancel affiliate payout request","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/affiliates/payout-requests/{id}/cancel","href":"/api-reference/affiliates/cancel-affiliate-payout-request"},{"title":"Get affiliate analytics","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/affiliates/analytics","href":"/api-reference/affiliates/get-affiliate-analytics"}]},{"group":"Allowlist","pages":[{"title":"List allowlist entries","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/allowlist","href":"/api-reference/allowlist/list-allowlist-entries"},{"title":"Create an allowlist entry","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/allowlist","href":"/api-reference/allowlist/create-an-allowlist-entry"},{"title":"Get an allowlist entry","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/allowlist/{id}","href":"/api-reference/allowlist/get-an-allowlist-entry"},{"title":"Delete an allowlist entry","deprecated":false,"version":null,"openapi":"/openapi.json delete /dev/v1/allowlist/{id}","href":"/api-reference/allowlist/delete-an-allowlist-entry"}]},{"group":"Analytics","pages":[{"title":"Get analytics revenue","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/analytics/revenue","href":"/api-reference/analytics/get-analytics-revenue"},{"title":"Get the sales overview","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/analytics/overview","href":"/api-reference/analytics/get-the-sales-overview"},{"title":"Get storefront traffic sources","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/analytics/traffic","href":"/api-reference/analytics/get-storefront-traffic-sources"}]},{"group":"Blacklist","pages":[{"title":"List blacklist entries","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/blacklist","href":"/api-reference/blacklist/list-blacklist-entries"},{"title":"Create a blacklist entry","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/blacklist","href":"/api-reference/blacklist/create-a-blacklist-entry"},{"title":"Get blacklist entry","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/blacklist/{id}","href":"/api-reference/blacklist/get-blacklist-entry"},{"title":"Delete blacklist entry","deprecated":false,"version":null,"openapi":"/openapi.json delete /dev/v1/blacklist/{id}","href":"/api-reference/blacklist/delete-blacklist-entry"}]},{"group":"Categories","pages":[{"title":"List categories","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/categories","href":"/api-reference/categories/list-categories"},{"title":"Create category","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/categories","href":"/api-reference/categories/create-category"},{"title":"Get category","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/categories/{id}","href":"/api-reference/categories/get-category"},{"title":"Update category","deprecated":false,"version":null,"openapi":"/openapi.json patch /dev/v1/categories/{id}","href":"/api-reference/categories/update-category"},{"title":"Delete category","deprecated":false,"version":null,"openapi":"/openapi.json delete /dev/v1/categories/{id}","href":"/api-reference/categories/delete-category"}]},{"group":"Code Storefronts","pages":[{"title":"List code storefronts","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/code-storefronts","href":"/api-reference/code-storefronts/list-code-storefronts"},{"title":"Get code storefront source manifest","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/code-storefronts/{id}/source","href":"/api-reference/code-storefronts/get-code-storefront-source-manifest"},{"title":"Replace code storefront source","deprecated":false,"version":null,"openapi":"/openapi.json put /dev/v1/code-storefronts/{id}/source","href":"/api-reference/code-storefronts/replace-code-storefront-source"},{"title":"Get code storefront source file","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/code-storefronts/{id}/source/content","href":"/api-reference/code-storefronts/get-code-storefront-source-file"},{"title":"Export code storefront source as a ZIP archive","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/code-storefronts/{id}/source/archive","href":"/api-reference/code-storefronts/export-code-storefront-source-as-a-zip-archive"},{"title":"Replace code storefront source from a ZIP archive","deprecated":false,"version":null,"openapi":"/openapi.json put /dev/v1/code-storefronts/{id}/source/archive","href":"/api-reference/code-storefronts/replace-code-storefront-source-from-a-zip-archive"},{"title":"Enqueue code storefront build","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/code-storefronts/{id}/builds","href":"/api-reference/code-storefronts/enqueue-code-storefront-build"},{"title":"Get current code storefront build","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/code-storefronts/{id}/builds/current","href":"/api-reference/code-storefronts/get-current-code-storefront-build"},{"title":"Publish code storefront","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/code-storefronts/{id}/publish","href":"/api-reference/code-storefronts/publish-code-storefront"}]},{"group":"Coupons","pages":[{"title":"List coupons","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/coupons","href":"/api-reference/coupons/list-coupons"},{"title":"Create coupon","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/coupons","href":"/api-reference/coupons/create-coupon"},{"title":"Validate coupon by code","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/coupons/code/{code}","href":"/api-reference/coupons/validate-coupon-by-code"},{"title":"Get coupon","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/coupons/{id}","href":"/api-reference/coupons/get-coupon"},{"title":"Update coupon","deprecated":false,"version":null,"openapi":"/openapi.json patch /dev/v1/coupons/{id}","href":"/api-reference/coupons/update-coupon"},{"title":"Delete coupon","deprecated":false,"version":null,"openapi":"/openapi.json delete /dev/v1/coupons/{id}","href":"/api-reference/coupons/delete-coupon"}]},{"group":"Customers","pages":[{"title":"List customers","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/customers","href":"/api-reference/customers/list-customers"},{"title":"Create customer","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/customers","href":"/api-reference/customers/create-customer"},{"title":"Get customer","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/customers/{id}","href":"/api-reference/customers/get-customer"},{"title":"Update customer","deprecated":false,"version":null,"openapi":"/openapi.json patch /dev/v1/customers/{id}","href":"/api-reference/customers/update-customer"},{"title":"Delete customer","deprecated":false,"version":null,"openapi":"/openapi.json delete /dev/v1/customers/{id}","href":"/api-reference/customers/delete-customer"},{"title":"Get customer affiliate","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/customers/{id}/affiliate","href":"/api-reference/customers/get-customer-affiliate"},{"title":"Get customer wallet","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/customers/{id}/wallet","href":"/api-reference/customers/get-customer-wallet"},{"title":"Credit customer wallet","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/customers/{id}/wallet/credit","href":"/api-reference/customers/credit-customer-wallet"},{"title":"Debit customer wallet","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/customers/{id}/wallet/debit","href":"/api-reference/customers/debit-customer-wallet"},{"title":"Convert affiliate balance","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/customers/{id}/affiliate/convert-to-balance","href":"/api-reference/customers/convert-affiliate-balance"},{"title":"Create customer affiliate payout request","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/customers/{id}/affiliate/payout-requests","href":"/api-reference/customers/create-customer-affiliate-payout-request"}]},{"group":"Email Marketing","pages":[{"title":"Get email marketing settings","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/email-marketing/settings","href":"/api-reference/email-marketing/get-email-marketing-settings"},{"title":"List email marketing contacts","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/email-marketing/contacts","href":"/api-reference/email-marketing/list-email-marketing-contacts"},{"title":"Create email marketing contact","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/email-marketing/contacts","href":"/api-reference/email-marketing/create-email-marketing-contact"},{"title":"List email marketing lists","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/email-marketing/lists","href":"/api-reference/email-marketing/list-email-marketing-lists"},{"title":"Get email marketing list","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/email-marketing/lists/{id}","href":"/api-reference/email-marketing/get-email-marketing-list"},{"title":"List email marketing segments","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/email-marketing/segments","href":"/api-reference/email-marketing/list-email-marketing-segments"},{"title":"Create email marketing segment","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/email-marketing/segments","href":"/api-reference/email-marketing/create-email-marketing-segment"},{"title":"List email marketing suppressions","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/email-marketing/suppressions","href":"/api-reference/email-marketing/list-email-marketing-suppressions"},{"title":"Create email marketing suppression","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/email-marketing/suppressions","href":"/api-reference/email-marketing/create-email-marketing-suppression"},{"title":"List email marketing campaigns","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/email-marketing/campaigns","href":"/api-reference/email-marketing/list-email-marketing-campaigns"},{"title":"Create email marketing campaign","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/email-marketing/campaigns","href":"/api-reference/email-marketing/create-email-marketing-campaign"},{"title":"Get email marketing campaign","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/email-marketing/campaigns/{id}","href":"/api-reference/email-marketing/get-email-marketing-campaign"},{"title":"List email marketing automations","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/email-marketing/automations","href":"/api-reference/email-marketing/list-email-marketing-automations"},{"title":"Create email marketing automation","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/email-marketing/automations","href":"/api-reference/email-marketing/create-email-marketing-automation"},{"title":"Create email marketing automation activate","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/email-marketing/automations/{id}/activate","href":"/api-reference/email-marketing/create-email-marketing-automation-activate"},{"title":"Create email marketing automation trigger","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/email-marketing/automations/trigger","href":"/api-reference/email-marketing/create-email-marketing-automation-trigger"},{"title":"Get email marketing billing usage","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/email-marketing/billing/usage","href":"/api-reference/email-marketing/get-email-marketing-billing-usage"}]},{"group":"Disputes \u0026 Escrow","pages":[{"title":"List disputes","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/disputes","href":"/api-reference/disputes-\u0026-escrow/list-disputes"},{"title":"Get dispute","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/disputes/{id}","href":"/api-reference/disputes-\u0026-escrow/get-dispute"},{"title":"List escrow records","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/escrow","href":"/api-reference/disputes-\u0026-escrow/list-escrow-records"},{"title":"Get escrow record","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/escrow/{id}","href":"/api-reference/disputes-\u0026-escrow/get-escrow-record"},{"title":"Release escrow record","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/escrow/{id}/release","href":"/api-reference/disputes-\u0026-escrow/release-escrow-record"}]},{"group":"Workflows","pages":[{"title":"List workflows","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/workflows","href":"/api-reference/workflows/list-workflows"},{"title":"Create a draft workflow","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/workflows","href":"/api-reference/workflows/create-a-draft-workflow"},{"title":"Get workflow","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/workflows/{id}","href":"/api-reference/workflows/get-workflow"},{"title":"Update workflow","deprecated":false,"version":null,"openapi":"/openapi.json patch /dev/v1/workflows/{id}","href":"/api-reference/workflows/update-workflow"},{"title":"Delete workflow","deprecated":false,"version":null,"openapi":"/openapi.json delete /dev/v1/workflows/{id}","href":"/api-reference/workflows/delete-workflow"},{"title":"Create workflow status","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/workflows/{id}/status","href":"/api-reference/workflows/create-workflow-status"},{"title":"Duplicate workflow","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/workflows/{id}/duplicate","href":"/api-reference/workflows/duplicate-workflow"},{"title":"Get workflow catalog","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/workflows/catalog","href":"/api-reference/workflows/get-workflow-catalog"},{"title":"List workflow templates","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/workflows/templates","href":"/api-reference/workflows/list-workflow-templates"},{"title":"Validate workflow","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/workflows/validate","href":"/api-reference/workflows/validate-workflow"},{"title":"Send test workflow","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/workflows/test","href":"/api-reference/workflows/send-test-workflow"},{"title":"List workflow runs","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/workflows/runs","href":"/api-reference/workflows/list-workflow-runs"},{"title":"Get workflow run","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/workflows/runs/{id}","href":"/api-reference/workflows/get-workflow-run"},{"title":"Cancel workflow run","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/workflows/runs/{id}/cancel","href":"/api-reference/workflows/cancel-workflow-run"},{"title":"Retry workflow run","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/workflows/runs/{id}/retry","href":"/api-reference/workflows/retry-workflow-run"},{"title":"Get workflow report","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/workflows/report","href":"/api-reference/workflows/get-workflow-report"}]},{"group":"Groups","pages":[{"title":"List groups","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/groups","href":"/api-reference/groups/list-groups"},{"title":"Create group","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/groups","href":"/api-reference/groups/create-group"},{"title":"Get group","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/groups/{uniqid}","href":"/api-reference/groups/get-group"},{"title":"Update group","deprecated":false,"version":null,"openapi":"/openapi.json patch /dev/v1/groups/{uniqid}","href":"/api-reference/groups/update-group"},{"title":"Delete group","deprecated":false,"version":null,"openapi":"/openapi.json delete /dev/v1/groups/{uniqid}","href":"/api-reference/groups/delete-group"}]},{"group":"Invoices","pages":[{"title":"List invoices","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/invoices","href":"/api-reference/invoices/list-invoices"},{"title":"Get invoice","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/invoices/{uniqid}","href":"/api-reference/invoices/get-invoice"},{"title":"Get the timeline of an invoice","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/invoices/{uniqid}/timeline","href":"/api-reference/invoices/get-the-timeline-of-an-invoice"},{"title":"Update invoice","deprecated":false,"version":null,"openapi":"/openapi.json patch /dev/v1/invoices/{uniqid}","href":"/api-reference/invoices/update-invoice"},{"title":"Trigger server-side invoice completion","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/invoices/{uniqid}/complete","href":"/api-reference/invoices/trigger-server-side-invoice-completion"},{"title":"Void invoice","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/invoices/{uniqid}/void","href":"/api-reference/invoices/void-invoice"},{"title":"Issue invoice replacement","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/invoices/{uniqid}/replacements","href":"/api-reference/invoices/issue-invoice-replacement"}]},{"group":"Licenses","pages":[{"title":"List licenses","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/licenses","href":"/api-reference/licenses/list-licenses"},{"title":"Create license","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/licenses","href":"/api-reference/licenses/create-license"},{"title":"Get license product","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/licenses/products/{product_id}","href":"/api-reference/licenses/get-license-product"},{"title":"Validate license","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/licenses/validate","href":"/api-reference/licenses/validate-license"},{"title":"Get license","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/licenses/{id}","href":"/api-reference/licenses/get-license"},{"title":"Update license","deprecated":false,"version":null,"openapi":"/openapi.json patch /dev/v1/licenses/{id}","href":"/api-reference/licenses/update-license"},{"title":"Reset license HWID","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/licenses/{id}/reset-hwid","href":"/api-reference/licenses/reset-license-hwid"},{"title":"Delete license","deprecated":false,"version":null,"openapi":"/openapi.json delete /dev/v1/licenses/{id}","href":"/api-reference/licenses/delete-license"},{"title":"Update license HWID","deprecated":false,"version":null,"openapi":"/openapi.json patch /dev/v1/licenses/keys/{key}/hwid","href":"/api-reference/licenses/update-license-hwid"}]},{"group":"Orders","pages":[{"title":"List orders","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/orders","href":"/api-reference/orders/list-orders"},{"title":"Create order from product line items","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/orders","href":"/api-reference/orders/create-order-from-product-line-items"},{"title":"Get order details","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/orders/{id}","href":"/api-reference/orders/get-order-details"},{"title":"Preview order affiliate attribution","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/orders/{id}/affiliate-preview","href":"/api-reference/orders/preview-order-affiliate-attribution"},{"title":"Update order affiliate attribution","deprecated":false,"version":null,"openapi":"/openapi.json patch /dev/v1/orders/{id}","href":"/api-reference/orders/update-order-affiliate-attribution"},{"title":"Replace order affiliate attribution","deprecated":false,"version":null,"openapi":"/openapi.json put /dev/v1/orders/{id}","href":"/api-reference/orders/replace-order-affiliate-attribution"},{"title":"Trigger server-side completion","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/orders/{id}/complete","href":"/api-reference/orders/trigger-server-side-completion"},{"title":"Trigger server-side fulfillment","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/orders/{id}/fulfill","href":"/api-reference/orders/trigger-server-side-fulfillment"},{"title":"Fulfill an order line item","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/orders/{id}/items/{itemId}/fulfill","href":"/api-reference/orders/fulfill-an-order-line-item"},{"title":"Retry a failed line-item delivery","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/orders/{id}/items/{itemId}/retry-delivery","href":"/api-reference/orders/retry-a-failed-line-item-delivery"},{"title":"Mark an order as shipped","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/orders/{id}/ship","href":"/api-reference/orders/mark-an-order-as-shipped"},{"title":"Mark an order as delivered","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/orders/{id}/deliver","href":"/api-reference/orders/mark-an-order-as-delivered"},{"title":"Refund an order","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/orders/{id}/refund","href":"/api-reference/orders/refund-an-order"}]},{"group":"Payment Links","pages":[{"title":"List payment links","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/payment-links","href":"/api-reference/payment-links/list-payment-links"},{"title":"Create payment link","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/payment-links","href":"/api-reference/payment-links/create-payment-link"},{"title":"Get payment link","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/payment-links/{id}","href":"/api-reference/payment-links/get-payment-link"},{"title":"Update payment link","deprecated":false,"version":null,"openapi":"/openapi.json patch /dev/v1/payment-links/{id}","href":"/api-reference/payment-links/update-payment-link"},{"title":"Delete payment link","deprecated":false,"version":null,"openapi":"/openapi.json delete /dev/v1/payment-links/{id}","href":"/api-reference/payment-links/delete-payment-link"},{"title":"Toggle payment link","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/payment-links/{id}/toggle","href":"/api-reference/payment-links/toggle-payment-link"}]},{"group":"Payments","pages":[{"title":"List payments","description":"Returns developer payments for the current shop. This endpoint lists payment records you already created through the Developer API; it does not return the shop's currently enabled payment methods. Use `/dev/v1/me/capabilities` when you need the payment methods enabled for the current shop. Session-backed gateways can include `checkout_url` and `session_id` when Shoppex owns the provider session.","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/payments","href":"/api-reference/payments/list-payments"},{"title":"Create payment","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/payments","href":"/api-reference/payments/create-payment"},{"title":"Create checkout session","description":"Stripe-style alias for `POST /dev/v1/payments`. Accepts `amount`, `success_url`, `cancel_url`, `customer_email`, and a single `product` descriptor; returns a session shape with `id`, `url`, and `status`. Internally delegates to the payments endpoint, so PSP orchestration, scopes, and webhook behavior are identical; `Idempotency-Key` replay is handled by this endpoint and returns the stored session response. For multi-item checkouts, build the cart on your side and call this endpoint with the aggregated amount.","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/checkout/sessions","href":"/api-reference/payments/create-checkout-session"},{"title":"Get payment","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/payments/{uniqid}","href":"/api-reference/payments/get-payment"},{"title":"Void payment","deprecated":false,"version":null,"openapi":"/openapi.json delete /dev/v1/payments/{uniqid}","href":"/api-reference/payments/void-payment"},{"title":"Complete payment","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/payments/{uniqid}/complete","href":"/api-reference/payments/complete-payment"}]},{"group":"Products","pages":[{"title":"Product images","icon":"image","href":"/developers/product-images"},{"title":"List products","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/products","href":"/api-reference/products/list-products"},{"title":"Create product","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/products","href":"/api-reference/products/create-product"},{"title":"Search products","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/products/search","href":"/api-reference/products/search-products"},{"title":"List back-in-stock demand","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/products/stock-alerts","href":"/api-reference/products/list-back-in-stock-demand"},{"title":"Upload an image","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/media","href":"/api-reference/media/upload-an-image"},{"title":"Bulk update products","deprecated":false,"version":null,"openapi":"/openapi.json patch /dev/v1/products/bulk","href":"/api-reference/products/bulk-update-products"},{"title":"Reorder products","deprecated":false,"version":null,"openapi":"/openapi.json patch /dev/v1/products/order","href":"/api-reference/products/reorder-products"},{"title":"List product addons","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/products/addons","href":"/api-reference/products/list-product-addons"},{"title":"Create product addon","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/products/addons","href":"/api-reference/products/create-product-addon"},{"title":"Get product addon","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/products/addons/{uniqid}","href":"/api-reference/products/get-product-addon"},{"title":"Update product addon","deprecated":false,"version":null,"openapi":"/openapi.json patch /dev/v1/products/addons/{uniqid}","href":"/api-reference/products/update-product-addon"},{"title":"Delete product addon","deprecated":false,"version":null,"openapi":"/openapi.json delete /dev/v1/products/addons/{uniqid}","href":"/api-reference/products/delete-product-addon"},{"title":"List product bundles","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/products/bundles","href":"/api-reference/products/list-product-bundles"},{"title":"Create product bundle","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/products/bundles","href":"/api-reference/products/create-product-bundle"},{"title":"Get product bundle","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/products/bundles/{uniqid}","href":"/api-reference/products/get-product-bundle"},{"title":"Update product bundle","deprecated":false,"version":null,"openapi":"/openapi.json patch /dev/v1/products/bundles/{uniqid}","href":"/api-reference/products/update-product-bundle"},{"title":"Delete product bundle","deprecated":false,"version":null,"openapi":"/openapi.json delete /dev/v1/products/bundles/{uniqid}","href":"/api-reference/products/delete-product-bundle"},{"title":"List product quantity deals","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/products/quantity-deals","href":"/api-reference/products/list-product-quantity-deals"},{"title":"Create product quantity deal","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/products/quantity-deals","href":"/api-reference/products/create-product-quantity-deal"},{"title":"Get product quantity deal","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/products/quantity-deals/{uniqid}","href":"/api-reference/products/get-product-quantity-deal"},{"title":"Update product quantity deal","deprecated":false,"version":null,"openapi":"/openapi.json patch /dev/v1/products/quantity-deals/{uniqid}","href":"/api-reference/products/update-product-quantity-deal"},{"title":"Delete product quantity deal","deprecated":false,"version":null,"openapi":"/openapi.json delete /dev/v1/products/quantity-deals/{uniqid}","href":"/api-reference/products/delete-product-quantity-deal"},{"title":"Get product","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/products/{id}","href":"/api-reference/products/get-product"},{"title":"Get product stock","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/products/{id}/stock","href":"/api-reference/products/get-product-stock"},{"title":"List product stock movements","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/products/{id}/stock-movements","href":"/api-reference/products/list-product-stock-movements"},{"title":"Update product","deprecated":false,"version":null,"openapi":"/openapi.json patch /dev/v1/products/{id}","href":"/api-reference/products/update-product"},{"title":"Delete product","deprecated":false,"version":null,"openapi":"/openapi.json delete /dev/v1/products/{id}","href":"/api-reference/products/delete-product"},{"title":"Duplicate product","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/products/{id}/duplicate","href":"/api-reference/products/duplicate-product"},{"title":"List product serials","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/products/{id}/serials","href":"/api-reference/products/list-product-serials"},{"title":"Update product serial","deprecated":false,"version":null,"openapi":"/openapi.json patch /dev/v1/products/{id}/serials/{serialId}","href":"/api-reference/products/update-product-serial"},{"title":"Delete all product serials","deprecated":false,"version":null,"openapi":"/openapi.json delete /dev/v1/products/{id}/serials/all","href":"/api-reference/products/delete-all-product-serials"},{"title":"Add product serials","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/products/{id}/serials","href":"/api-reference/products/add-product-serials"},{"title":"Claim product serials","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/products/{id}/serials/claim","href":"/api-reference/products/claim-product-serials"},{"title":"Remove product serials","deprecated":false,"version":null,"openapi":"/openapi.json delete /dev/v1/products/{id}/serials","href":"/api-reference/products/remove-product-serials"},{"title":"List product variants","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/products/{id}/variants","href":"/api-reference/products/list-product-variants"},{"title":"Create variant","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/products/{id}/variants","href":"/api-reference/products/create-variant"},{"title":"Reorder variants","deprecated":false,"version":null,"openapi":"/openapi.json patch /dev/v1/products/{id}/variants/order","href":"/api-reference/products/reorder-variants"},{"title":"Get variant","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/products/{id}/variants/{variantId}","href":"/api-reference/products/get-variant"},{"title":"Update variant","deprecated":false,"version":null,"openapi":"/openapi.json patch /dev/v1/products/{id}/variants/{variantId}","href":"/api-reference/products/update-variant"},{"title":"Delete variant","deprecated":false,"version":null,"openapi":"/openapi.json delete /dev/v1/products/{id}/variants/{variantId}","href":"/api-reference/products/delete-variant"},{"title":"List variant serials","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/products/{id}/variants/{variantId}/serials","href":"/api-reference/products/list-variant-serials"},{"title":"Add variant serials","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/products/{id}/variants/{variantId}/serials","href":"/api-reference/products/add-variant-serials"},{"title":"Delete all variant serials","deprecated":false,"version":null,"openapi":"/openapi.json delete /dev/v1/products/{id}/variants/{variantId}/serials/all","href":"/api-reference/variants/delete-all-variant-serials"},{"title":"Remove variant serials","deprecated":false,"version":null,"openapi":"/openapi.json delete /dev/v1/products/{id}/variants/{variantId}/serials","href":"/api-reference/products/remove-variant-serials"}]},{"group":"Resellers","pages":[{"title":"List resellers","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/resellers","href":"/api-reference/resellers/list-resellers"},{"title":"Retrieve a reseller","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/resellers/{id}","href":"/api-reference/resellers/retrieve-a-reseller"},{"title":"Invite a reseller","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/resellers/invite","href":"/api-reference/resellers/invite-a-reseller"},{"title":"Suspend a reseller","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/resellers/{id}/suspend","href":"/api-reference/resellers/suspend-a-reseller"},{"title":"Reinstate a reseller","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/resellers/{id}/reinstate","href":"/api-reference/resellers/reinstate-a-reseller"},{"title":"Retrieve the reseller program","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/reseller-program","href":"/api-reference/resellers/retrieve-the-reseller-program"},{"title":"Update the reseller program","deprecated":false,"version":null,"openapi":"/openapi.json patch /dev/v1/reseller-program","href":"/api-reference/resellers/update-the-reseller-program"},{"title":"List reseller tiers","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/reseller-tiers","href":"/api-reference/resellers/list-reseller-tiers"}]},{"group":"Reviews","pages":[{"title":"List reviews","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/reviews","href":"/api-reference/reviews/list-reviews"},{"title":"Get a review","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/reviews/{uniqid}","href":"/api-reference/reviews/get-a-review"},{"title":"Reply to a review","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/reviews/{uniqid}/reply","href":"/api-reference/reviews/reply-to-a-review"}]},{"group":"Security","pages":[{"title":"Get security settings","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/security","href":"/api-reference/security/get-security-settings"},{"title":"Update security settings","deprecated":false,"version":null,"openapi":"/openapi.json patch /dev/v1/security","href":"/api-reference/security/update-security-settings"},{"title":"List security shared blacklists","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/security/shared-blacklists","href":"/api-reference/security/list-security-shared-blacklists"},{"title":"List security events","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/security/events","href":"/api-reference/security/list-security-events"},{"title":"Get advanced security settings","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/security/security-settings","href":"/api-reference/security/get-advanced-security-settings"},{"title":"Update advanced security settings","deprecated":false,"version":null,"openapi":"/openapi.json patch /dev/v1/security/security-settings","href":"/api-reference/security/update-advanced-security-settings"},{"title":"Get session trail","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/security/session-trail/{session_id}","href":"/api-reference/security/get-session-trail"},{"title":"Get audit trail","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/security/audit-trail","href":"/api-reference/security/get-audit-trail"}]},{"group":"Shipping Zones","pages":[{"title":"List shipping zones","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/shipping-zones","href":"/api-reference/shipping-zones/list-shipping-zones"},{"title":"Create a shipping zone","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/shipping-zones","href":"/api-reference/shipping-zones/create-a-shipping-zone"},{"title":"Get a shipping zone","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/shipping-zones/{id}","href":"/api-reference/shipping-zones/get-a-shipping-zone"},{"title":"Replace a shipping zone","deprecated":false,"version":null,"openapi":"/openapi.json put /dev/v1/shipping-zones/{id}","href":"/api-reference/shipping-zones/replace-a-shipping-zone"},{"title":"Delete a shipping zone","deprecated":false,"version":null,"openapi":"/openapi.json delete /dev/v1/shipping-zones/{id}","href":"/api-reference/shipping-zones/delete-a-shipping-zone"}]},{"group":"Store","pages":[{"title":"Get store settings","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/store/settings","href":"/api-reference/store/get-store-settings"},{"title":"Summarize the store settings","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/store/settings/summary","href":"/api-reference/store/summarize-the-store-settings"},{"title":"List what needs attention","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/store/attention","href":"/api-reference/store/list-what-needs-attention"},{"title":"Get the platform billing status","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/store/billing","href":"/api-reference/store/get-the-platform-billing-status"},{"title":"Get the crypto wallet balances","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/store/wallet","href":"/api-reference/store/get-the-crypto-wallet-balances"},{"title":"List store domains","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/store/domains","href":"/api-reference/store/list-store-domains"},{"title":"Get custom domain status","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/store/domains/custom/status","href":"/api-reference/store/get-custom-domain-status"},{"title":"Enable custom domain","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/store/domains/custom/enable","href":"/api-reference/store/enable-custom-domain"},{"title":"Update custom domain","deprecated":false,"version":null,"openapi":"/openapi.json patch /dev/v1/store/domains/custom","href":"/api-reference/store/update-custom-domain"},{"title":"Disable custom domain","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/store/domains/custom/disable","href":"/api-reference/store/disable-custom-domain"},{"title":"Add additional domain","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/store/domains/additional","href":"/api-reference/store/add-additional-domain"},{"title":"Get additional domain verification","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/store/domains/additional/{id}/verification","href":"/api-reference/store/get-additional-domain-verification"},{"title":"Enable additional domain","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/store/domains/additional/{id}/enable","href":"/api-reference/store/enable-additional-domain"},{"title":"Disable additional domain","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/store/domains/additional/{id}/disable","href":"/api-reference/store/disable-additional-domain"},{"title":"Request additional domain validation","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/store/domains/additional/{id}/request-validation","href":"/api-reference/store/request-additional-domain-validation"},{"title":"Delete additional domain","deprecated":false,"version":null,"openapi":"/openapi.json delete /dev/v1/store/domains/additional/{id}","href":"/api-reference/store/delete-additional-domain"},{"title":"Get store branding","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/store/branding","href":"/api-reference/store/get-store-branding"},{"title":"Get store features","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/store/features","href":"/api-reference/store/get-store-features"},{"title":"Get storefront layout","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/store/layout","href":"/api-reference/store/get-storefront-layout"},{"title":"Update storefront layout","deprecated":false,"version":null,"openapi":"/openapi.json put /dev/v1/store/layout","href":"/api-reference/store/update-storefront-layout"}]},{"group":"Themes","pages":[{"title":"List themes","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/themes","href":"/api-reference/themes/list-themes"},{"title":"Create theme","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/themes/control/create","href":"/api-reference/themes/create-theme"},{"title":"Start theme preview","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/themes/{id}/control/preview","href":"/api-reference/themes/start-theme-preview"},{"title":"Stop theme preview","deprecated":false,"version":null,"openapi":"/openapi.json delete /dev/v1/themes/{id}/control/preview/{sessionId}","href":"/api-reference/themes/stop-theme-preview"},{"title":"Publish theme","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/themes/{id}/control/publish","href":"/api-reference/themes/publish-theme"},{"title":"Get theme builder settings","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/themes/{id}/control/settings","href":"/api-reference/themes/get-theme-builder-settings"},{"title":"Update theme builder settings","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/themes/{id}/control/settings","href":"/api-reference/themes/update-theme-builder-settings"},{"title":"Get theme document","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/themes/{id}/control/document","href":"/api-reference/themes/get-theme-document"},{"title":"Get editable theme document draft","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/themes/{id}/control/document/draft","href":"/api-reference/themes/get-editable-theme-document-draft"},{"title":"Save theme document draft","deprecated":false,"version":null,"openapi":"/openapi.json put /dev/v1/themes/{id}/control/document","href":"/api-reference/themes/save-theme-document-draft"},{"title":"Get theme document schema","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/themes/{id}/control/document/schema","href":"/api-reference/themes/get-theme-document-schema"},{"title":"Get ThemeDocument JSON Schema for editors","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/themes/{id}/control/document/json-schema","href":"/api-reference/themes/get-themedocument-json-schema-for-editors"}]},{"group":"Team","pages":[{"title":"List the team","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/team","href":"/api-reference/team/list-the-team"}]},{"group":"Telegram","pages":[{"title":"List telegram bots","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/telegram/bots","href":"/api-reference/telegram/list-telegram-bots"},{"title":"Create telegram bot","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/telegram/bots","href":"/api-reference/telegram/create-telegram-bot"},{"title":"Update telegram bot agent","deprecated":false,"version":null,"openapi":"/openapi.json put /dev/v1/telegram/bots/{botId}/agent","href":"/api-reference/telegram/update-telegram-bot-agent"},{"title":"Get telegram agent stats","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/telegram/bots/{botId}/agent/stats","href":"/api-reference/telegram/get-telegram-agent-stats"},{"title":"Delete telegram bot","deprecated":false,"version":null,"openapi":"/openapi.json delete /dev/v1/telegram/bots/{botId}","href":"/api-reference/telegram/delete-telegram-bot"},{"title":"List telegram bot users","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/telegram/bots/{botId}/users","href":"/api-reference/telegram/list-telegram-bot-users"},{"title":"Get telegram bot user","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/telegram/bots/{botId}/users/{userId}","href":"/api-reference/telegram/get-telegram-bot-user"},{"title":"Update telegram user notification","deprecated":false,"version":null,"openapi":"/openapi.json put /dev/v1/telegram/bots/{botId}/users/{userId}/notifications","href":"/api-reference/telegram/update-telegram-user-notification"},{"title":"Update telegram bulk notification","deprecated":false,"version":null,"openapi":"/openapi.json put /dev/v1/telegram/bots/{botId}/users/bulk/notifications","href":"/api-reference/telegram/update-telegram-bulk-notification"},{"title":"Get telegram user stats","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/telegram/bots/{botId}/users/stats","href":"/api-reference/telegram/get-telegram-user-stats"},{"title":"Create telegram bot broadcast","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/telegram/bots/{botId}/broadcasts","href":"/api-reference/telegram/create-telegram-bot-broadcast"},{"title":"List telegram bot broadcasts","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/telegram/bots/{botId}/broadcasts","href":"/api-reference/telegram/list-telegram-bot-broadcasts"},{"title":"Get telegram bot broadcast","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/telegram/bots/{botId}/broadcasts/{id}","href":"/api-reference/telegram/get-telegram-bot-broadcast"},{"title":"Update telegram bot broadcast","deprecated":false,"version":null,"openapi":"/openapi.json put /dev/v1/telegram/bots/{botId}/broadcasts/{id}","href":"/api-reference/telegram/update-telegram-bot-broadcast"},{"title":"Delete telegram bot broadcast","deprecated":false,"version":null,"openapi":"/openapi.json delete /dev/v1/telegram/bots/{botId}/broadcasts/{id}","href":"/api-reference/telegram/delete-telegram-bot-broadcast"},{"title":"Start telegram bot broadcast","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/telegram/bots/{botId}/broadcasts/{id}/start","href":"/api-reference/telegram/start-telegram-bot-broadcast"},{"title":"Cancel telegram bot broadcast","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/telegram/bots/{botId}/broadcasts/{id}/cancel","href":"/api-reference/telegram/cancel-telegram-bot-broadcast"},{"title":"Get telegram broadcast stats","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/telegram/bots/{botId}/broadcasts/{id}/stats","href":"/api-reference/telegram/get-telegram-broadcast-stats"},{"title":"Get telegram broadcast analytics","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/telegram/bots/{botId}/broadcasts/{id}/analytics","href":"/api-reference/telegram/get-telegram-broadcast-analytics"},{"title":"Send product restock broadcast","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/telegram/bots/{botId}/broadcasts/restock","href":"/api-reference/telegram/send-product-restock-broadcast"},{"title":"Get telegram bot analytics","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/telegram/bots/{botId}/analytics","href":"/api-reference/telegram/get-telegram-bot-analytics"},{"title":"List inbox conversations","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/telegram/bots/{botId}/inbox","href":"/api-reference/telegram/list-inbox-conversations"},{"title":"Get inbox conversation","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/telegram/bots/{botId}/inbox/{conversationId}","href":"/api-reference/telegram/get-inbox-conversation"},{"title":"Reply to inbox conversation","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/telegram/bots/{botId}/inbox/{conversationId}/reply","href":"/api-reference/telegram/reply-to-inbox-conversation"},{"title":"Update inbox conversation status","deprecated":false,"version":null,"openapi":"/openapi.json put /dev/v1/telegram/bots/{botId}/inbox/{conversationId}/status","href":"/api-reference/telegram/update-inbox-conversation-status"},{"title":"List telegram bot journeys","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/telegram/bots/{botId}/journeys","href":"/api-reference/telegram/list-telegram-bot-journeys"},{"title":"Create telegram bot journey","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/telegram/bots/{botId}/journeys","href":"/api-reference/telegram/create-telegram-bot-journey"},{"title":"Get telegram bot journey","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/telegram/bots/{botId}/journeys/{journeyId}","href":"/api-reference/telegram/get-telegram-bot-journey"},{"title":"Update telegram bot journey","deprecated":false,"version":null,"openapi":"/openapi.json put /dev/v1/telegram/bots/{botId}/journeys/{journeyId}","href":"/api-reference/telegram/update-telegram-bot-journey"},{"title":"Delete telegram bot journey","deprecated":false,"version":null,"openapi":"/openapi.json delete /dev/v1/telegram/bots/{botId}/journeys/{journeyId}","href":"/api-reference/telegram/delete-telegram-bot-journey"},{"title":"Send test telegram bot journey","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/telegram/bots/{botId}/journeys/{journeyId}/test","href":"/api-reference/telegram/send-test-telegram-bot-journey"}]},{"group":"Subscriptions","pages":[{"title":"List subscriptions","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/subscriptions","href":"/api-reference/subscriptions/list-subscriptions"},{"title":"Get subscription","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/subscriptions/{id}","href":"/api-reference/subscriptions/get-subscription"},{"title":"Cancel subscription","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/subscriptions/{id}/cancel","href":"/api-reference/subscriptions/cancel-subscription"},{"title":"Pause subscription","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/subscriptions/{id}/pause","href":"/api-reference/subscriptions/pause-subscription"},{"title":"Resume subscription","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/subscriptions/{id}/resume","href":"/api-reference/subscriptions/resume-subscription"},{"title":"Change subscription plan","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/subscriptions/{id}/change-plan","href":"/api-reference/subscriptions/change-subscription-plan"},{"title":"Refund subscription","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/subscriptions/{id}/refund","href":"/api-reference/subscriptions/refund-subscription"},{"title":"List subscription plan options","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/subscriptions/{id}/plan-options","href":"/api-reference/subscriptions/list-subscription-plan-options"},{"title":"Update subscription custom fields","deprecated":false,"version":null,"openapi":"/openapi.json patch /dev/v1/subscriptions/{id}/custom-fields","href":"/api-reference/subscriptions/update-subscription-custom-fields"},{"title":"List subscription billing history","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/subscriptions/{id}/billing-history","href":"/api-reference/subscriptions/list-subscription-billing-history"}]},{"group":"Tickets","pages":[{"title":"List tickets","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/tickets","href":"/api-reference/tickets/list-tickets"},{"title":"Create ticket","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/tickets","href":"/api-reference/tickets/create-ticket"},{"title":"Get ticket","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/tickets/{id}","href":"/api-reference/tickets/get-ticket"},{"title":"Close ticket","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/tickets/{id}/close","href":"/api-reference/tickets/close-ticket"},{"title":"Reopen ticket","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/tickets/{id}/reopen","href":"/api-reference/tickets/reopen-ticket"},{"title":"Create ticket message","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/tickets/{id}/messages","href":"/api-reference/tickets/create-ticket-message"}]},{"group":"Webhook Endpoints","pages":[{"title":"List webhooks","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/webhooks","href":"/api-reference/webhook-endpoints/list-webhooks"},{"title":"Create webhook","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/webhooks","href":"/api-reference/webhook-endpoints/create-webhook"},{"title":"List webhook events","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/webhooks/events","href":"/api-reference/webhook-endpoints/list-webhook-events"},{"title":"List webhook logs","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/webhooks/logs","href":"/api-reference/webhook-endpoints/list-webhook-logs"},{"title":"Get webhook log","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/webhooks/logs/{id}","href":"/api-reference/webhook-endpoints/get-webhook-log"},{"title":"Retry webhook log","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/webhooks/logs/{id}/retry","href":"/api-reference/webhook-endpoints/retry-webhook-log"},{"title":"Get webhook","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/webhooks/{id}","href":"/api-reference/webhook-endpoints/get-webhook"},{"title":"Update webhook","deprecated":false,"version":null,"openapi":"/openapi.json patch /dev/v1/webhooks/{id}","href":"/api-reference/webhook-endpoints/update-webhook"},{"title":"Delete webhook","deprecated":false,"version":null,"openapi":"/openapi.json delete /dev/v1/webhooks/{id}","href":"/api-reference/webhook-endpoints/delete-webhook"},{"title":"Send test webhook","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/webhooks/{id}/test","href":"/api-reference/webhook-endpoints/send-test-webhook"},{"title":"Rotate webhook secret","deprecated":false,"version":null,"openapi":"/openapi.json post /dev/v1/webhooks/{id}/rotate-secret","href":"/api-reference/webhook-endpoints/rotate-webhook-secret"}]},{"group":"Replacements","pages":[{"title":"List replacement audit events","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/replacement-events","href":"/api-reference/replacements/list-replacement-audit-events"},{"title":"Get replacement audit event","deprecated":false,"version":null,"openapi":"/openapi.json get /dev/v1/replacement-events/{id}","href":"/api-reference/replacements/get-replacement-audit-event"}]}]}]},"title":"Create payment - Shoppex","buildId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","deploymentId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-BRm_l__d.js","utils-f1l1Oc-G.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BlhqDhJO.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DHCB7rsC.js","snippetPresets-CYXLx6Hv.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-B78P2dEq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C4YLPVAh.js","shallow-vlLnTDkQ.js","getApiPlaygroundDisplay-D_98hhvf.js","CodeSnippet-DtnZHGqq.js","CodeSnippets-CLFb8KJt.js","Page-kQh739Uz.js","getPastedJson-Cq-zlbnU.js","icon-sN3t983t.js","MethodPill-P_YQ2s09.js","DuplicateIcon-BVzyNsGJ.js","createIcon-B3jqgqC6.js","DynamicMarkdown-Crwq6WG_.js","SectionHeading-C7pGS2Bb.js","axios-vUo_bRtp.js","Markdown-BuPH8yuW.js","clsx-CCOYKgaU.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BnkC_6oA.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BM4S31-f.js"]}