1:I["911c8e14a321",[],"RevpressProvider",1] 2:I["b0b3943575f9",[],"Link",1] 3:I["cdb22823b999",[],"MenuGroupItem",1] 6:I["98d563c3c055",[],"ToastProvider",1] 7:I["9ab2c8c971c4",[],"LayoutTopNav",1] 8:I["3c81c6443917",[],"LayoutMenu",1] 9:I["741b00e3790d",[],"AIToolbar",1] a:I["29504dfc1207",[],"ErrorBoundary",1] b:I["98d563c3c055",[],"Box",1] c:I["98d563c3c055",[],"StatusWidget",1] d:I["52683481a7bd",[],"StatusWidgetImage",1] e:I["52683481a7bd",[],"StatusWidgetTitle",1] f:I["52683481a7bd",[],"StatusWidgetDescription",1] 71:I["98d563c3c055",[],"Icon",1] 72:I["98d563c3c055",[],"Link",1] 73:I["9083c63ad443",[],"CopyAnchor",1] 74:I["98d563c3c055",[],"Checkbox",1] 75:I["8ef6b74664e6",[],"Tabs",1] 76:I["8ef6b74664e6",[],"TabItem",1] 82:I["98d563c3c055",[],"Avatar",1] 8f:I["cc1bdf5ea256",[],"FloatingTableOfContents",1] 90:I["98d563c3c055",[],"Spacer",1] 91:I["34a8762a918d",[],"Feedback",1] 92:I["98d563c3c055",[],"Item",1] 93:I["52683481a7bd",[],"ItemContent",1] 94:I["52683481a7bd",[],"ItemTitle",1] 95:I["52683481a7bd",[],"ItemDescription",1] 96:I["7726099d401e",[],"LayoutFeed",1] 97:I["cc1bdf5ea256",[],"TableOfContents",1] 98:I["98d563c3c055",[],"ToastContainer",1] a0:I["d67d6639dc67",[],"PreviewOverlay",1] a2:I["669a0b877249",[],"CopyButton",1] a4:I["50460d952402",[],"ScrollArea",1] :HL["/_assets/request-CYv_dcSn.css","stylesheet"] :HL["https://assets.revolut.com/Brand/Retail/Logos/Wordmark/Revolut_Black.svg","image"] :HL["https://assets.revolut.com/Brand/Retail/Logos/Wordmark/Revolut_White.svg","image"] 0:{"root":["$","html",null,{"suppressHydrationWarning":true,"lang":"en","data-feature-web-density":"true","data-banner-id":"$undefined","children":[["$","head",null,{"children":[[["$","meta",null,{"charSet":"utf-8"}],["$","meta",null,{"name":"viewport","content":"width=device-width, initial-scale=1"}],["$","meta",null,{"name":"color-scheme","content":"light dark"}],["$","meta",null,{"name":"generator","content":"Revpress v0.9.3"}],["$","meta",null,{"property":"og:site_name","content":"Developer"}],["$","meta",null,{"property":"og:type","content":"website"}]],[["$","link","css:/_assets/request-CYv_dcSn.css",{"rel":"stylesheet","precedence":"vite-rsc/importer-resources","href":"/_assets/request-CYv_dcSn.css","data-rsc-css-href":"/_assets/request-CYv_dcSn.css"}],"$undefined"],["$","script",null,{"src":"/_assets/theme-init-2d2b4912.js"}],[["$","link",null,{"rel":"apple-touch-icon","sizes":"180x180","href":"/_assets/favicons/apple-touch-icon.png"}],["$","link",null,{"rel":"icon","type":"image/png","sizes":"32x32","href":"/_assets/favicons/favicon-32x32.png"}],["$","link",null,{"rel":"icon","type":"image/png","sizes":"16x16","href":"/_assets/favicons/favicon-16x16.png"}],["$","link",null,{"rel":"icon","type":"image/png","sizes":"192x192","href":"/_assets/favicons/android-chrome-192x192.png"}],["$","link",null,{"rel":"icon","type":"image/png","sizes":"512x512","href":"/_assets/favicons/android-chrome-512x512.png"}],["$","link",null,{"rel":"shortcut icon","href":"/_assets/favicons/favicon.ico"}]]]}],["$","body",null,{"className":"pjjwra0","children":["$","$L1",null,{"nav":[{"item":{"id":"Guides","title":"Guides","items":[{"id":"/docs/guides/merchant/introduction","title":"Merchant","use":"$2","to":"/docs/guides/merchant/introduction","scope":"/docs/guides/merchant","items":[{"id":"/docs/guides/merchant/accept-payments/online-payments/revolut-pay/introduction","title":"Accept Revolut Pay payments","use":"$2","to":"/docs/guides/merchant/accept-payments/online-payments/revolut-pay/introduction","scope":"/docs/guides/merchant"},{"id":"/docs/guides/merchant/accept-payments/online-payments/card-payments/introduction","title":"Accept card payments","use":"$2","to":"/docs/guides/merchant/accept-payments/online-payments/card-payments/introduction","scope":"/docs/guides/merchant"},{"id":"/docs/guides/merchant/accept-payments/online-payments/apple-pay-google-pay/introduction","title":"Accept Apple Pay and Google Pay payments","use":"$2","to":"/docs/guides/merchant/accept-payments/online-payments/apple-pay-google-pay/introduction","scope":"/docs/guides/merchant"},{"id":"/docs/guides/merchant/accept-payments/online-payments/pay-by-bank/introduction","title":"Accept direct bank payments","use":"$2","to":"/docs/guides/merchant/accept-payments/online-payments/pay-by-bank/introduction","scope":"/docs/guides/merchant"},{"id":"/docs/guides/merchant/accept-payments/online-payments/revolut-checkout/introduction","title":"Accept payments with Revolut Checkout","use":"$2","to":"/docs/guides/merchant/accept-payments/online-payments/revolut-checkout/introduction","scope":"/docs/guides/merchant"},{"id":"/docs/guides/merchant/accept-payments/online-payments/hosted-checkout-page/introduction","title":"Accept payments via Hosted Checkout Page","use":"$2","to":"/docs/guides/merchant/accept-payments/online-payments/hosted-checkout-page/introduction","scope":"/docs/guides/merchant"},{"id":"/docs/guides/merchant/accept-payments/online-payments/sepa-direct-debit/introduction","title":"Accept payments via SEPA Direct Debit","use":"$2","to":"/docs/guides/merchant/accept-payments/online-payments/sepa-direct-debit/introduction","scope":"/docs/guides/merchant"},{"id":"/docs/guides/merchant/accept-payments/online-payments/click-to-pay/introduction","title":"Accept payments via Click to Pay","use":"$2","to":"/docs/guides/merchant/accept-payments/online-payments/click-to-pay/introduction","scope":"/docs/guides/merchant"},{"id":"/docs/guides/merchant/accept-payments/no-code/plugins/introduction","title":"Plugins and integrations","use":"$2","to":"/docs/guides/merchant/accept-payments/no-code/plugins/introduction","scope":"/docs/guides/merchant"},{"id":"/docs/guides/merchant/accept-payments/in-person-payments/introduction","title":"In-person payments","use":"$2","to":"/docs/guides/merchant/accept-payments/in-person-payments/introduction","scope":"/docs/guides/merchant"}]},{"id":"/docs/guides/manage-accounts/introduction","title":"Business","use":"$2","to":"/docs/guides/manage-accounts/introduction","scope":"/docs/guides/manage-accounts","items":[{"id":"/docs/guides/manage-accounts/transfers/send-money","title":"Send money","use":"$2","to":"/docs/guides/manage-accounts/transfers/send-money","scope":"/docs/guides/manage-accounts"},{"id":"/docs/guides/manage-accounts/accounts-and-transactions/manage-your-accounts","title":"Manage your money","use":"$2","to":"/docs/guides/manage-accounts/accounts-and-transactions/manage-your-accounts","scope":"/docs/guides/manage-accounts"},{"id":"/docs/guides/manage-accounts/exchange-money","title":"Exchange currency","use":"$2","to":"/docs/guides/manage-accounts/exchange-money","scope":"/docs/guides/manage-accounts"},{"id":"/docs/guides/manage-accounts/cards/manage-cards","title":"Manage cards","use":"$2","to":"/docs/guides/manage-accounts/cards/manage-cards","scope":"/docs/guides/manage-accounts"},{"id":"/docs/guides/manage-accounts/teams/manage-team-members","title":"Manage your team","use":"$2","to":"/docs/guides/manage-accounts/teams/manage-team-members","scope":"/docs/guides/manage-accounts"}]},{"id":"/docs/guides/build-banking-apps/introduction-to-the-open-banking-api/introduction","title":"Open Banking","use":"$2","to":"/docs/guides/build-banking-apps/introduction-to-the-open-banking-api/introduction","scope":"/docs/guides/build-banking-apps","items":[{"id":"/docs/guides/build-banking-apps/tutorials/initiate-your-first-payment","title":"Make payments","use":"$2","to":"/docs/guides/build-banking-apps/tutorials/initiate-your-first-payment","scope":"/docs/guides/build-banking-apps"},{"id":"/docs/guides/build-banking-apps/tutorials/get-account-and-transaction-information","title":"Get account information","use":"$2","to":"/docs/guides/build-banking-apps/tutorials/get-account-and-transaction-information","scope":"/docs/guides/build-banking-apps"}]},{"id":"/docs/guides/crypto-ramp/introduction-to-revolut-ramp/introduction-to-revolut-ramp","title":"Crypto Ramp","use":"$2","to":"/docs/guides/crypto-ramp/introduction-to-revolut-ramp/introduction-to-revolut-ramp","scope":"/docs/guides/crypto-ramp","items":[{"id":"/docs/guides/crypto-ramp/get-started/integrate-with-revolut-ramp","title":"Integrate with Revolut Ramp","use":"$2","to":"/docs/guides/crypto-ramp/get-started/integrate-with-revolut-ramp","scope":"/docs/guides/crypto-ramp"}]}]}},{"item":{"id":"APIs","title":"APIs","items":[{"id":"/docs/api/merchant","title":"Merchant API","use":"$2","to":"/docs/api/merchant","items":[{"id":"/docs/api/merchant#tag-orders","title":"Orders","use":"$2","to":"/docs/api/merchant#tag-orders"},{"id":"/docs/api/merchant#tag-customers","title":"Customers","use":"$2","to":"/docs/api/merchant#tag-customers"},{"id":"/docs/api/merchant#tag-payments","title":"Payments","use":"$2","to":"/docs/api/merchant#tag-payments"},{"id":"/docs/api/merchant#tag-subscriptions","title":"Subscriptions","use":"$2","to":"/docs/api/merchant#tag-subscriptions"},{"id":"/docs/api/merchant#tag-payouts","title":"Payouts","use":"$2","to":"/docs/api/merchant#tag-payouts"},{"id":"/docs/api/merchant#tag-disputes","title":"Disputes","use":"$2","to":"/docs/api/merchant#tag-disputes"},{"id":"/docs/api/merchant#tag-report-runs","title":"Report runs","use":"$2","to":"/docs/api/merchant#tag-report-runs"},{"id":"/docs/api/merchant#tag-webhooks","title":"Webhooks","use":"$2","to":"/docs/api/merchant#tag-webhooks"},{"id":"/docs/api/merchant#tag-locations","title":"Locations","use":"$2","to":"/docs/api/merchant#tag-locations"}]},{"id":"/docs/api/business","title":"Business API","use":"$2","to":"/docs/api/business","items":[{"id":"/docs/api/business#tag-accounting","title":"Accounting settings","use":"$2","to":"/docs/api/business#tag-accounting"},{"id":"/docs/api/business#tag-accounts","title":"Accounts","use":"$2","to":"/docs/api/business#tag-accounts"},{"id":"/docs/api/business#tag-cards","title":"Cards","use":"$2","to":"/docs/api/business#tag-cards"},{"id":"/docs/api/business#tag-counterparties","title":"Counterparties","use":"$2","to":"/docs/api/business#tag-counterparties"},{"id":"/docs/api/business#tag-expenses","title":"Expenses","use":"$2","to":"/docs/api/business#tag-expenses"},{"id":"/docs/api/business#tag-foreign-exchange","title":"Foreign exchange","use":"$2","to":"/docs/api/business#tag-foreign-exchange"},{"id":"/docs/api/business#tag-payment-drafts","title":"Payment drafts","use":"$2","to":"/docs/api/business#tag-payment-drafts"},{"id":"/docs/api/business#tag-payout-links","title":"Payout links","use":"$2","to":"/docs/api/business#tag-payout-links"},{"id":"/docs/api/business#tag-teams","title":"Teams","use":"$2","to":"/docs/api/business#tag-teams"},{"id":"/docs/api/business#tag-transactions","title":"Transactions","use":"$2","to":"/docs/api/business#tag-transactions"},{"id":"/docs/api/business#tag-transfers","title":"Transfers","use":"$2","to":"/docs/api/business#tag-transfers"},{"id":"/docs/api/business#tag-webhooks-v2","title":"Webhooks","use":"$2","to":"/docs/api/business#tag-webhooks-v2"}]},{"id":"/docs/api/open-banking","title":"Open Banking API","use":"$2","to":"/docs/api/open-banking","items":[{"id":"/docs/api/open-banking#tag-accounts","title":"Accounts","use":"$2","to":"/docs/api/open-banking#tag-accounts"},{"id":"/docs/api/open-banking#tag-applications","title":"Applications","use":"$2","to":"/docs/api/open-banking#tag-applications"},{"id":"/docs/api/open-banking#tag-domestic-payment","title":"Payments","use":"$2","to":"/docs/api/open-banking#tag-domestic-payment"},{"id":"/docs/api/open-banking#tag-transactions","title":"Transactions","use":"$2","to":"/docs/api/open-banking#tag-transactions"}]},{"id":"/docs/api/crypto-ramp","title":"Crypto Ramp API","use":"$2","to":"/docs/api/crypto-ramp","items":[{"id":"/docs/api/crypto-ramp#tag-partners","title":"Partners","use":"$2","to":"/docs/api/crypto-ramp#tag-partners"},{"id":"/docs/api/crypto-ramp#tag-webhooks","title":"Webhooks","use":"$2","to":"/docs/api/crypto-ramp#tag-webhooks"}]},{"id":"/docs/guides/exchange-fix-api/introduction-to-the-exchange-fix-api/exchange-fix-api","title":"Crypto Exchange APIs","use":"$2","to":"/docs/guides/exchange-fix-api/introduction-to-the-exchange-fix-api/exchange-fix-api","scope":"/docs/guides/exchange-fix-api","items":[{"id":"/docs/guides/exchange-fix-api/introduction-to-the-exchange-fix-api/exchange-fix-api","title":"Crypto Exchange FIX API","use":"$2","to":"/docs/guides/exchange-fix-api/introduction-to-the-exchange-fix-api/exchange-fix-api","scope":"/docs/guides/exchange-fix-api"},{"id":"/docs/api/revolut-x-crypto-exchange","title":"Crypto Exchange REST API","use":"$2","to":"/docs/api/revolut-x-crypto-exchange"}]}]}},{"item":{"id":"SDKs","title":"SDKs","items":[{"id":"/docs/sdks/merchant-web-sdk/introduction","title":"Merchant Web SDKs","use":"$2","to":"/docs/sdks/merchant-web-sdk/introduction","scope":"/docs/sdks/merchant-web-sdk","items":[{"id":"/docs/sdks/merchant-web-sdk/payment-methods/embedded-checkout","title":"Revolut Checkout","use":"$2","to":"/docs/sdks/merchant-web-sdk/payment-methods/embedded-checkout","scope":"/docs/sdks/merchant-web-sdk"},{"id":"/docs/sdks/merchant-web-sdk/payment-methods/revolut-pay","title":"Revolut Pay","use":"$2","to":"/docs/sdks/merchant-web-sdk/payment-methods/revolut-pay","scope":"/docs/sdks/merchant-web-sdk"},{"id":"/docs/sdks/merchant-web-sdk/payment-methods/apple-pay-google-pay","title":"Apple Pay and Google Pay","use":"$2","to":"/docs/sdks/merchant-web-sdk/payment-methods/apple-pay-google-pay","scope":"/docs/sdks/merchant-web-sdk"},{"id":"/docs/sdks/merchant-web-sdk/payment-methods/pay-by-bank","title":"Pay by Bank","use":"$2","to":"/docs/sdks/merchant-web-sdk/payment-methods/pay-by-bank","scope":"/docs/sdks/merchant-web-sdk"},{"id":"/docs/sdks/merchant-web-sdk/payment-methods/sepa-direct-debit","title":"SEPA Direct Debit","use":"$2","to":"/docs/sdks/merchant-web-sdk/payment-methods/sepa-direct-debit","scope":"/docs/sdks/merchant-web-sdk"},{"id":"/docs/sdks/merchant-web-sdk/payment-methods/click-to-pay","title":"Click to Pay","use":"$2","to":"/docs/sdks/merchant-web-sdk/payment-methods/click-to-pay","scope":"/docs/sdks/merchant-web-sdk"},{"id":"/docs/sdks/merchant-web-sdk/payment-methods/card-field","title":"Card field","use":"$2","to":"/docs/sdks/merchant-web-sdk/payment-methods/card-field","scope":"/docs/sdks/merchant-web-sdk"},{"id":"/docs/sdks/merchant-web-sdk/payment-methods/pop-up","title":"Card pop-up","use":"$2","to":"/docs/sdks/merchant-web-sdk/payment-methods/pop-up","scope":"/docs/sdks/merchant-web-sdk"},{"id":"/docs/sdks/merchant-web-sdk/promotional-widgets/introduction","title":"Promotional widgets","use":"$2","to":"/docs/sdks/merchant-web-sdk/promotional-widgets/introduction","scope":"/docs/sdks/merchant-web-sdk"}]},{"id":"/docs/sdks/merchant-ios-sdk/introduction","title":"Merchant iOS SDKs","use":"$2","to":"/docs/sdks/merchant-ios-sdk/introduction","scope":"/docs/sdks/merchant-ios-sdk","items":[{"id":"/docs/sdks/merchant-ios-sdk/revolut-pay-ios-sdk/introduction","title":"Revolut Pay","use":"$2","to":"/docs/sdks/merchant-ios-sdk/revolut-pay-ios-sdk/introduction","scope":"/docs/sdks/merchant-ios-sdk"},{"id":"/docs/sdks/merchant-ios-sdk/apple-pay-ios-sdk/introduction","title":"Apple Pay","use":"$2","to":"/docs/sdks/merchant-ios-sdk/apple-pay-ios-sdk/introduction","scope":"/docs/sdks/merchant-ios-sdk"},{"id":"/docs/sdks/merchant-ios-sdk/tap-to-pay-sdk/introduction","title":"Tap to Pay","use":"$2","to":"/docs/sdks/merchant-ios-sdk/tap-to-pay-sdk/introduction","scope":"/docs/sdks/merchant-ios-sdk"},{"id":"/docs/sdks/merchant-ios-sdk/revolut-card-form-ios-sdk/introduction","title":"Card Form","use":"$2","to":"/docs/sdks/merchant-ios-sdk/revolut-card-form-ios-sdk/introduction","scope":"/docs/sdks/merchant-ios-sdk"}]},{"id":"/docs/sdks/merchant-android-sdk/introduction","title":"Merchant Android SDKs","use":"$2","to":"/docs/sdks/merchant-android-sdk/introduction","scope":"/docs/sdks/merchant-android-sdk","items":[{"id":"/docs/sdks/merchant-android-sdk/revolut-pay-android-sdk/introduction","title":"Revolut Pay","use":"$2","to":"/docs/sdks/merchant-android-sdk/revolut-pay-android-sdk/introduction","scope":"/docs/sdks/merchant-android-sdk"},{"id":"/docs/sdks/merchant-android-sdk/revolut-card-form-android-sdk/introduction","title":"Card Form","use":"$2","to":"/docs/sdks/merchant-android-sdk/revolut-card-form-android-sdk/introduction","scope":"/docs/sdks/merchant-android-sdk"}]},{"id":"/docs/sdks/revolut-id-sdk/introduction","title":"Revolut ID SDKs","use":"$2","to":"/docs/sdks/revolut-id-sdk/introduction","scope":"/docs/sdks/revolut-id-sdk","items":[{"id":"/docs/sdks/revolut-id-sdk/web/introduction","title":"Web","use":"$2","to":"/docs/sdks/revolut-id-sdk/web/introduction","scope":"/docs/sdks/revolut-id-sdk"},{"id":"/docs/sdks/revolut-id-sdk/ios/introduction","title":"iOS","use":"$2","to":"/docs/sdks/revolut-id-sdk/ios/introduction","scope":"/docs/sdks/revolut-id-sdk"},{"id":"/docs/sdks/revolut-id-sdk/android/introduction","title":"Android","use":"$2","to":"/docs/sdks/revolut-id-sdk/android/introduction","scope":"/docs/sdks/revolut-id-sdk"}]}]}},{"item":{"id":"Resources","title":"Resources","items":[{"id":"/docs/resources/marketing-guidelines","title":"Revolut Pay marketing assets and guidelines","use":"$2","to":"/docs/resources/marketing-guidelines","scope":"/docs/resources"},{"id":"/docs/resources/revolut-pay-button-guidelines","title":"Revolut Pay button guidelines","use":"$2","to":"/docs/resources/revolut-pay-button-guidelines","scope":"/docs/resources"},{"id":"/docs/resources/open-banking-logo-guidelines","title":"Revolut Open Banking logo assets and guidelines","use":"$2","to":"/docs/resources/open-banking-logo-guidelines","scope":"/docs/resources"}]}},{"item":{"id":"More","title":"More","items":[{"id":"/blog","title":"Blog","use":"$2","to":"/blog","scope":"/blog"},{"id":"https://developer.revolut.com/portal/signup","title":"Developer Portal","use":"a","href":"https://developer.revolut.com/portal/signup","target":"_blank","rel":"noreferrer"}]}}],"menu":{"docs":[{"id":"/docs","title":"Docs","use":"$2","items":[{"id":"/docs/guides","title":"Guides","use":"$2","items":[]},{"id":"/docs/sdks","title":"Sdks","use":"$2","items":[]}]},{"id":"/docs/guides/api-console","title":"API Console","use":"$2","root":true,"items":[{"id":"/docs/guides/api-console/introduction","title":"Introduction","to":"/docs/guides/api-console/introduction","use":"$2"},{"id":"/docs/guides/api-console/get-started","title":"Get started","to":"/docs/guides/api-console/get-started","use":"$2"},{"id":"separator-/docs/guides/api-console-2-API KEY MANAGEMENT","title":"API KEY MANAGEMENT","use":"$3"},{"id":"/docs/guides/api-console/create-key","title":"Create an API key","to":"/docs/guides/api-console/create-key","use":"$2"},{"id":"/docs/guides/api-console/signing-requirements","title":"Signing requirements","to":"/docs/guides/api-console/signing-requirements","use":"$2"},{"id":"/docs/guides/api-console/manage-key-permissions","title":"Manage API key settings","to":"/docs/guides/api-console/manage-key-permissions","use":"$2"},{"id":"/docs/guides/api-console/replicate-key-to-production","title":"Replicate an API key to Production","to":"/docs/guides/api-console/replicate-key-to-production","use":"$2"},{"id":"/docs/guides/api-console/rotate-api-key","title":"Rotate an API key","to":"/docs/guides/api-console/rotate-api-key","use":"$2"},{"id":"separator-/docs/guides/api-console-8-TESTING & INTEGRATION","title":"TESTING & INTEGRATION","use":"$3"},{"id":"/docs/guides/api-console/make-a-request","title":"Make a request","to":"/docs/guides/api-console/make-a-request","use":"$2"},{"id":"/docs/guides/api-console/test-with-sandbox","title":"Test your integration with Revolut Sandbox","to":"/docs/guides/api-console/test-with-sandbox","use":"$2"},{"id":"/docs/guides/api-console/set-up-postman","title":"Set up Postman","to":"/docs/guides/api-console/set-up-postman","use":"$2"}]},{"id":"/docs/guides/build-banking-apps","title":"Build Banking Apps","use":"$2","root":true,"items":[{"id":"/docs/guides/build-banking-apps/introduction-to-the-open-banking-api","title":"Introduction to the Open Banking API","use":"$2","items":[{"id":"/docs/guides/build-banking-apps/introduction-to-the-open-banking-api/introduction","title":"Introduction","to":"/docs/guides/build-banking-apps/introduction-to-the-open-banking-api/introduction","use":"$2"},{"id":"/docs/guides/build-banking-apps/introduction-to-the-open-banking-api/who-can-access-the-api","title":"Who can access the API","to":"/docs/guides/build-banking-apps/introduction-to-the-open-banking-api/who-can-access-the-api","use":"$2"},{"id":"/docs/guides/build-banking-apps/introduction-to-the-open-banking-api/global-customer-access-controls","title":"Global customer access controls","to":"/docs/guides/build-banking-apps/introduction-to-the-open-banking-api/global-customer-access-controls","use":"$2"}]},{"id":"/docs/guides/build-banking-apps/get-started","title":"Get started","use":"$2","items":[{"id":"/docs/guides/build-banking-apps/get-started/register-your-application-in-the-developer-portal","title":"1. Register your application in the Developer Portal","to":"/docs/guides/build-banking-apps/get-started/register-your-application-in-the-developer-portal","use":"$2"},{"id":"/docs/guides/build-banking-apps/get-started/prepare-sandbox-environment","title":"2. Prepare your Sandbox environment","to":"/docs/guides/build-banking-apps/get-started/prepare-sandbox-environment","use":"$2"},{"id":"/docs/guides/build-banking-apps/get-started/setup-prod-environment","title":"3. Set up production environment","to":"/docs/guides/build-banking-apps/get-started/setup-prod-environment","use":"$2"},{"id":"/docs/guides/build-banking-apps/get-started/get-access-token","title":"4. Get the access token","to":"/docs/guides/build-banking-apps/get-started/get-access-token","use":"$2"}]},{"id":"/docs/guides/build-banking-apps/register-your-application-using-dcr","title":"Register your application using DCR","use":"$2","to":"/docs/guides/build-banking-apps/register-your-application-using-dcr","items":[{"id":"/docs/guides/build-banking-apps/register-your-application-using-dcr/get-the-jwks-url","title":"1. Get the JWKs URL","to":"/docs/guides/build-banking-apps/register-your-application-using-dcr/get-the-jwks-url","use":"$2"},{"id":"/docs/guides/build-banking-apps/register-your-application-using-dcr/get-the-software-statement","title":"2. Get the software statement","to":"/docs/guides/build-banking-apps/register-your-application-using-dcr/get-the-software-statement","use":"$2"},{"id":"/docs/guides/build-banking-apps/register-your-application-using-dcr/get-your-certificates-distinguished-name","title":"3. Get your certificate's distinguished name","to":"/docs/guides/build-banking-apps/register-your-application-using-dcr/get-your-certificates-distinguished-name","use":"$2"},{"id":"/docs/guides/build-banking-apps/register-your-application-using-dcr/create-a-jwt","title":"4. Create a JWT","to":"/docs/guides/build-banking-apps/register-your-application-using-dcr/create-a-jwt","use":"$2"},{"id":"/docs/guides/build-banking-apps/register-your-application-using-dcr/validate-your-jwt","title":"5. Validate your JWT","to":"/docs/guides/build-banking-apps/register-your-application-using-dcr/validate-your-jwt","use":"$2"},{"id":"/docs/guides/build-banking-apps/register-your-application-using-dcr/get-a-client-id","title":"6. Get a client ID","to":"/docs/guides/build-banking-apps/register-your-application-using-dcr/get-a-client-id","use":"$2"},{"id":"/docs/guides/build-banking-apps/register-your-application-using-dcr/open-id-configuration-urls","title":"Open ID configuration URLs","to":"/docs/guides/build-banking-apps/register-your-application-using-dcr/open-id-configuration-urls","use":"$2"}]},{"id":"/docs/guides/build-banking-apps/manage-your-applications","title":"Manage your applications","use":"$2","items":[{"id":"/docs/guides/build-banking-apps/manage-your-applications/get-an-application","title":"Retrieve application data","to":"/docs/guides/build-banking-apps/manage-your-applications/get-an-application","use":"$2"},{"id":"/docs/guides/build-banking-apps/manage-your-applications/update-an-application","title":"Update application data","to":"/docs/guides/build-banking-apps/manage-your-applications/update-an-application","use":"$2"},{"id":"/docs/guides/build-banking-apps/manage-your-applications/update-certificates","title":"Update application certificates","to":"/docs/guides/build-banking-apps/manage-your-applications/update-certificates","use":"$2"},{"id":"/docs/guides/build-banking-apps/manage-your-applications/delete-an-application","title":"Delete an application","to":"/docs/guides/build-banking-apps/manage-your-applications/delete-an-application","use":"$2"}]},{"id":"/docs/guides/build-banking-apps/tutorials","title":"Tutorials","use":"$2","items":[{"id":"/docs/guides/build-banking-apps/tutorials/get-account-and-transaction-information","title":"Get account and transaction information","to":"/docs/guides/build-banking-apps/tutorials/get-account-and-transaction-information","use":"$2"},{"id":"/docs/guides/build-banking-apps/tutorials/initiate-your-first-payment","title":"Initiate your first payment","to":"/docs/guides/build-banking-apps/tutorials/initiate-your-first-payment","use":"$2"},{"id":"/docs/guides/build-banking-apps/tutorials/test-with-postman","title":"Test with Postman","use":"$2","items":[{"id":"/docs/guides/build-banking-apps/tutorials/test-with-postman/set-up-postman","title":"Set up Postman","to":"/docs/guides/build-banking-apps/tutorials/test-with-postman/set-up-postman","use":"$2"},{"id":"/docs/guides/build-banking-apps/tutorials/test-with-postman/get-an-account-access-consent","title":"Get an account access consent","to":"/docs/guides/build-banking-apps/tutorials/test-with-postman/get-an-account-access-consent","use":"$2"},{"id":"/docs/guides/build-banking-apps/tutorials/test-with-postman/get-a-payment-consent","title":"Get a payment consent","to":"/docs/guides/build-banking-apps/tutorials/test-with-postman/get-a-payment-consent","use":"$2"}]},{"id":"/docs/guides/build-banking-apps/tutorials/create-a-file-payment","title":"Create a file payment","to":"/docs/guides/build-banking-apps/tutorials/create-a-file-payment","use":"$2"},{"id":"/docs/guides/build-banking-apps/tutorials/create-your-first-draft-payment","title":"Create your first draft payment","to":"/docs/guides/build-banking-apps/tutorials/create-your-first-draft-payment","use":"$2"},{"id":"/docs/guides/build-banking-apps/tutorials/work-with-draft-payments","title":"Work with draft payments","to":"/docs/guides/build-banking-apps/tutorials/work-with-draft-payments","use":"$2"},{"id":"/docs/guides/build-banking-apps/tutorials/work-with-json-web-tokens","title":"Work with JSON Web Tokens","to":"/docs/guides/build-banking-apps/tutorials/work-with-json-web-tokens","use":"$2"},{"id":"/docs/guides/build-banking-apps/tutorials/work-with-json-web-signatures","title":"Work with JSON Web Signatures","to":"/docs/guides/build-banking-apps/tutorials/work-with-json-web-signatures","use":"$2"}]},{"id":"/docs/guides/build-banking-apps/api-metrics","title":"API metrics","to":"/docs/guides/build-banking-apps/api-metrics","use":"$2"},{"id":"/docs/guides/build-banking-apps/usage-and-limits","title":"Usage and limits","to":"/docs/guides/build-banking-apps/usage-and-limits","use":"$2"},{"id":"/docs/guides/build-banking-apps/glossary","title":"Glossary","to":"/docs/guides/build-banking-apps/glossary","use":"$2"},{"id":"/docs/guides/build-banking-apps/faqs","title":"FAQs","to":"/docs/guides/build-banking-apps/faqs","use":"$2"},{"id":"/docs/guides/build-banking-apps/errors","title":"Errors","to":"/docs/guides/build-banking-apps/errors","use":"$2"}]},{"id":"/docs/guides/crypto-ramp","title":"Crypto Ramp","use":"$2","root":true,"items":[{"id":"/docs/guides/crypto-ramp/introduction-to-revolut-ramp","title":"Introduction to Revolut Ramp","use":"$2","items":[{"id":"/docs/guides/crypto-ramp/introduction-to-revolut-ramp/introduction-to-revolut-ramp","title":"Introduction","to":"/docs/guides/crypto-ramp/introduction-to-revolut-ramp/introduction-to-revolut-ramp","use":"$2"},{"id":"/docs/guides/crypto-ramp/introduction-to-revolut-ramp/partner-journey","title":"Partner journey","to":"/docs/guides/crypto-ramp/introduction-to-revolut-ramp/partner-journey","use":"$2"},{"id":"/docs/guides/crypto-ramp/introduction-to-revolut-ramp/coverage-and-other-details","title":"Coverage and other details","use":"$2","items":[{"id":"/docs/guides/crypto-ramp/introduction-to-revolut-ramp/coverage-and-other-details/crypto-tokens","title":"Tokens","to":"/docs/guides/crypto-ramp/introduction-to-revolut-ramp/coverage-and-other-details/crypto-tokens","use":"$2"},{"id":"/docs/guides/crypto-ramp/introduction-to-revolut-ramp/coverage-and-other-details/currencies-and-regions","title":"Currencies and regions","to":"/docs/guides/crypto-ramp/introduction-to-revolut-ramp/coverage-and-other-details/currencies-and-regions","use":"$2"},{"id":"/docs/guides/crypto-ramp/introduction-to-revolut-ramp/coverage-and-other-details/payment-options","title":"Payment options","to":"/docs/guides/crypto-ramp/introduction-to-revolut-ramp/coverage-and-other-details/payment-options","use":"$2"},{"id":"/docs/guides/crypto-ramp/introduction-to-revolut-ramp/coverage-and-other-details/limits-and-fees","title":"Limits and fees","to":"/docs/guides/crypto-ramp/introduction-to-revolut-ramp/coverage-and-other-details/limits-and-fees","use":"$2"}]},{"id":"/docs/guides/crypto-ramp/introduction-to-revolut-ramp/integration-options","title":"Integration with Revolut Ramp","to":"/docs/guides/crypto-ramp/introduction-to-revolut-ramp/integration-options","use":"$2"},{"id":"/docs/guides/crypto-ramp/introduction-to-revolut-ramp/configuration-options","title":"Configuration options","to":"/docs/guides/crypto-ramp/introduction-to-revolut-ramp/configuration-options","use":"$2"}]},{"id":"/docs/guides/crypto-ramp/get-started","title":"Get started","use":"$2","items":[{"id":"/docs/guides/crypto-ramp/get-started/integrate-with-revolut-ramp","title":"Integrate with Revolut Ramp","to":"/docs/guides/crypto-ramp/get-started/integrate-with-revolut-ramp","use":"$2"},{"id":"/docs/guides/crypto-ramp/get-started/initiate-transaction","title":"Initiate a transaction","to":"/docs/guides/crypto-ramp/get-started/initiate-transaction","use":"$2"},{"id":"/docs/guides/crypto-ramp/get-started/customer-perspective","title":"Create an order - customer's perspective","to":"/docs/guides/crypto-ramp/get-started/customer-perspective","use":"$2"}]},{"id":"/docs/guides/crypto-ramp/tutorials","title":"API usage and testing","use":"$2","items":[{"id":"/docs/guides/crypto-ramp/tutorials/test-the-integration","title":"Test the integration","to":"/docs/guides/crypto-ramp/tutorials/test-the-integration","use":"$2"},{"id":"/docs/guides/crypto-ramp/tutorials/use-the-api","title":"Leverage the Crypto Ramp API","to":"/docs/guides/crypto-ramp/tutorials/use-the-api","use":"$2"},{"id":"/docs/guides/crypto-ramp/tutorials/work-with-webhooks","title":"Work with webhooks","use":"$2","items":[{"id":"/docs/guides/crypto-ramp/tutorials/work-with-webhooks/use-webhooks","title":"Track order and payment lifecycle","to":"/docs/guides/crypto-ramp/tutorials/work-with-webhooks/use-webhooks","use":"$2"},{"id":"/docs/guides/crypto-ramp/tutorials/work-with-webhooks/verify-the-payload-signature","title":"Verify the payload signature","to":"/docs/guides/crypto-ramp/tutorials/work-with-webhooks/verify-the-payload-signature","use":"$2"}]}]},{"id":"/docs/guides/crypto-ramp/glossary","title":"Glossary","to":"/docs/guides/crypto-ramp/glossary","use":"$2"}]},{"id":"/docs/guides/exchange-fix-api","title":"Exchange FIX API","use":"$2","root":true,"items":[{"id":"/docs/guides/exchange-fix-api/introduction-to-the-exchange-fix-api","title":"Introduction to the Revolut Exchange FIX API","use":"$2","items":[{"id":"/docs/guides/exchange-fix-api/introduction-to-the-exchange-fix-api/exchange-fix-api","title":"Introduction","to":"/docs/guides/exchange-fix-api/introduction-to-the-exchange-fix-api/exchange-fix-api","use":"$2"},{"id":"/docs/guides/exchange-fix-api/introduction-to-the-exchange-fix-api/system-overview","title":"System overview","to":"/docs/guides/exchange-fix-api/introduction-to-the-exchange-fix-api/system-overview","use":"$2"},{"id":"/docs/guides/exchange-fix-api/introduction-to-the-exchange-fix-api/reading-instructions","title":"Reading instructions","to":"/docs/guides/exchange-fix-api/introduction-to-the-exchange-fix-api/reading-instructions","use":"$2"}]},{"id":"/docs/guides/exchange-fix-api/trading-fix-api","title":"Trading FIX API","use":"$2","items":[{"id":"/docs/guides/exchange-fix-api/trading-fix-api/supported-fix-messages","title":"Supported FIX messages","use":"$2","items":[{"id":"/docs/guides/exchange-fix-api/trading-fix-api/supported-fix-messages/supported-fix-messages-trading-overview","title":"Overview","to":"/docs/guides/exchange-fix-api/trading-fix-api/supported-fix-messages/supported-fix-messages-trading-overview","use":"$2"},{"id":"/docs/guides/exchange-fix-api/trading-fix-api/supported-fix-messages/fix-session-level-messages","title":"Session level messages","use":"$2","items":[{"id":"/docs/guides/exchange-fix-api/trading-fix-api/supported-fix-messages/fix-session-level-messages/message-A-logon","title":"A (Logon)","to":"/docs/guides/exchange-fix-api/trading-fix-api/supported-fix-messages/fix-session-level-messages/message-A-logon","use":"$2"},{"id":"/docs/guides/exchange-fix-api/trading-fix-api/supported-fix-messages/fix-session-level-messages/message-0-heartbeat","title":"0 (Heartbeat)","to":"/docs/guides/exchange-fix-api/trading-fix-api/supported-fix-messages/fix-session-level-messages/message-0-heartbeat","use":"$2"},{"id":"/docs/guides/exchange-fix-api/trading-fix-api/supported-fix-messages/fix-session-level-messages/message-1-test-request","title":"1 (Test request)","to":"/docs/guides/exchange-fix-api/trading-fix-api/supported-fix-messages/fix-session-level-messages/message-1-test-request","use":"$2"},{"id":"/docs/guides/exchange-fix-api/trading-fix-api/supported-fix-messages/fix-session-level-messages/message-2-resend-request","title":"2 (Resend request)","to":"/docs/guides/exchange-fix-api/trading-fix-api/supported-fix-messages/fix-session-level-messages/message-2-resend-request","use":"$2"},{"id":"/docs/guides/exchange-fix-api/trading-fix-api/supported-fix-messages/fix-session-level-messages/message-3-session-level-reject","title":"3 (Session level reject)","to":"/docs/guides/exchange-fix-api/trading-fix-api/supported-fix-messages/fix-session-level-messages/message-3-session-level-reject","use":"$2"},{"id":"/docs/guides/exchange-fix-api/trading-fix-api/supported-fix-messages/fix-session-level-messages/message-4-reset-sequence","title":"4 (Sequence reset)","to":"/docs/guides/exchange-fix-api/trading-fix-api/supported-fix-messages/fix-session-level-messages/message-4-reset-sequence","use":"$2"},{"id":"/docs/guides/exchange-fix-api/trading-fix-api/supported-fix-messages/fix-session-level-messages/message-5-logout","title":"5 (Logout)","to":"/docs/guides/exchange-fix-api/trading-fix-api/supported-fix-messages/fix-session-level-messages/message-5-logout","use":"$2"}]},{"id":"/docs/guides/exchange-fix-api/trading-fix-api/supported-fix-messages/fix-application-level-messages","title":"Application level messages","use":"$2","items":[{"id":"/docs/guides/exchange-fix-api/trading-fix-api/supported-fix-messages/fix-application-level-messages/standard-message-header","title":"Standard message header","to":"/docs/guides/exchange-fix-api/trading-fix-api/supported-fix-messages/fix-application-level-messages/standard-message-header","use":"$2"},{"id":"/docs/guides/exchange-fix-api/trading-fix-api/supported-fix-messages/fix-application-level-messages/standard-message-trailer","title":"Standard message trailer","to":"/docs/guides/exchange-fix-api/trading-fix-api/supported-fix-messages/fix-application-level-messages/standard-message-trailer","use":"$2"},{"id":"/docs/guides/exchange-fix-api/trading-fix-api/supported-fix-messages/fix-application-level-messages/order-state-transitions","title":"Order state transitions","to":"/docs/guides/exchange-fix-api/trading-fix-api/supported-fix-messages/fix-application-level-messages/order-state-transitions","use":"$2"},{"id":"/docs/guides/exchange-fix-api/trading-fix-api/supported-fix-messages/fix-application-level-messages/currency-pairs","title":"Currency pairs","to":"/docs/guides/exchange-fix-api/trading-fix-api/supported-fix-messages/fix-application-level-messages/currency-pairs","use":"$2"},{"id":"/docs/guides/exchange-fix-api/trading-fix-api/supported-fix-messages/fix-application-level-messages/order-rejection-codes","title":"Order rejection codes","to":"/docs/guides/exchange-fix-api/trading-fix-api/supported-fix-messages/fix-application-level-messages/order-rejection-codes","use":"$2"},{"id":"/docs/guides/exchange-fix-api/trading-fix-api/supported-fix-messages/fix-application-level-messages/message-D-new-order-single","title":"D (New order - single)","to":"/docs/guides/exchange-fix-api/trading-fix-api/supported-fix-messages/fix-application-level-messages/message-D-new-order-single","use":"$2"},{"id":"/docs/guides/exchange-fix-api/trading-fix-api/supported-fix-messages/fix-application-level-messages/message-F-order-cancel-request","title":"F (Order cancel request)","to":"/docs/guides/exchange-fix-api/trading-fix-api/supported-fix-messages/fix-application-level-messages/message-F-order-cancel-request","use":"$2"},{"id":"/docs/guides/exchange-fix-api/trading-fix-api/supported-fix-messages/fix-application-level-messages/message-G-order-cancel-replace-request","title":"G (Order cancel/replace request)","to":"/docs/guides/exchange-fix-api/trading-fix-api/supported-fix-messages/fix-application-level-messages/message-G-order-cancel-replace-request","use":"$2"},{"id":"/docs/guides/exchange-fix-api/trading-fix-api/supported-fix-messages/fix-application-level-messages/message-H-order-status-request","title":"H (Order status request)","to":"/docs/guides/exchange-fix-api/trading-fix-api/supported-fix-messages/fix-application-level-messages/message-H-order-status-request","use":"$2"},{"id":"/docs/guides/exchange-fix-api/trading-fix-api/supported-fix-messages/fix-application-level-messages/message-q-order-mass-cancel-request","title":"q (Order mass cancel request)","to":"/docs/guides/exchange-fix-api/trading-fix-api/supported-fix-messages/fix-application-level-messages/message-q-order-mass-cancel-request","use":"$2"},{"id":"/docs/guides/exchange-fix-api/trading-fix-api/supported-fix-messages/fix-application-level-messages/message-8-execution-report","title":"8 (Execution report)","to":"/docs/guides/exchange-fix-api/trading-fix-api/supported-fix-messages/fix-application-level-messages/message-8-execution-report","use":"$2"},{"id":"/docs/guides/exchange-fix-api/trading-fix-api/supported-fix-messages/fix-application-level-messages/message-9-order-cancel-reject","title":"9 (Order cancel reject)","to":"/docs/guides/exchange-fix-api/trading-fix-api/supported-fix-messages/fix-application-level-messages/message-9-order-cancel-reject","use":"$2"},{"id":"/docs/guides/exchange-fix-api/trading-fix-api/supported-fix-messages/fix-application-level-messages/message-j-business-message-reject","title":"j (Business message reject)","to":"/docs/guides/exchange-fix-api/trading-fix-api/supported-fix-messages/fix-application-level-messages/message-j-business-message-reject","use":"$2"},{"id":"/docs/guides/exchange-fix-api/trading-fix-api/supported-fix-messages/fix-application-level-messages/message-r-order-mass-cancel-report","title":"r (Order mass cancel report)","to":"/docs/guides/exchange-fix-api/trading-fix-api/supported-fix-messages/fix-application-level-messages/message-r-order-mass-cancel-report","use":"$2"}]}]}]},{"id":"/docs/guides/exchange-fix-api/market-data-fix-api","title":"Market Data FIX API","use":"$2","items":[{"id":"/docs/guides/exchange-fix-api/market-data-fix-api/supported-fix-messages","title":"Supported FIX messages","use":"$2","items":[{"id":"/docs/guides/exchange-fix-api/market-data-fix-api/supported-fix-messages/supported-fix-messages-market-data-overview","title":"Overview","to":"/docs/guides/exchange-fix-api/market-data-fix-api/supported-fix-messages/supported-fix-messages-market-data-overview","use":"$2"},{"id":"/docs/guides/exchange-fix-api/market-data-fix-api/supported-fix-messages/fix-session-level-messages","title":"Session level messages","use":"$2","items":[{"id":"/docs/guides/exchange-fix-api/market-data-fix-api/supported-fix-messages/fix-session-level-messages/message-A-logon","title":"A (Logon)","to":"/docs/guides/exchange-fix-api/market-data-fix-api/supported-fix-messages/fix-session-level-messages/message-A-logon","use":"$2"},{"id":"/docs/guides/exchange-fix-api/market-data-fix-api/supported-fix-messages/fix-session-level-messages/message-0-heartbeat","title":"0 (Heartbeat)","to":"/docs/guides/exchange-fix-api/market-data-fix-api/supported-fix-messages/fix-session-level-messages/message-0-heartbeat","use":"$2"},{"id":"/docs/guides/exchange-fix-api/market-data-fix-api/supported-fix-messages/fix-session-level-messages/message-1-test-request","title":"1 (Test request)","to":"/docs/guides/exchange-fix-api/market-data-fix-api/supported-fix-messages/fix-session-level-messages/message-1-test-request","use":"$2"},{"id":"/docs/guides/exchange-fix-api/market-data-fix-api/supported-fix-messages/fix-session-level-messages/message-2-resend-request","title":"2 (Resend request)","to":"/docs/guides/exchange-fix-api/market-data-fix-api/supported-fix-messages/fix-session-level-messages/message-2-resend-request","use":"$2"},{"id":"/docs/guides/exchange-fix-api/market-data-fix-api/supported-fix-messages/fix-session-level-messages/message-3-session-level-reject","title":"3 (Session level reject)","to":"/docs/guides/exchange-fix-api/market-data-fix-api/supported-fix-messages/fix-session-level-messages/message-3-session-level-reject","use":"$2"},{"id":"/docs/guides/exchange-fix-api/market-data-fix-api/supported-fix-messages/fix-session-level-messages/message-4-reset-sequence","title":"4 (Sequence reset)","to":"/docs/guides/exchange-fix-api/market-data-fix-api/supported-fix-messages/fix-session-level-messages/message-4-reset-sequence","use":"$2"},{"id":"/docs/guides/exchange-fix-api/market-data-fix-api/supported-fix-messages/fix-session-level-messages/message-5-logout","title":"5 (Logout)","to":"/docs/guides/exchange-fix-api/market-data-fix-api/supported-fix-messages/fix-session-level-messages/message-5-logout","use":"$2"}]},{"id":"/docs/guides/exchange-fix-api/market-data-fix-api/supported-fix-messages/fix-application-level-messages","title":"Application level messages","use":"$2","items":[{"id":"/docs/guides/exchange-fix-api/market-data-fix-api/supported-fix-messages/fix-application-level-messages/standard-message-header","title":"Standard message header","to":"/docs/guides/exchange-fix-api/market-data-fix-api/supported-fix-messages/fix-application-level-messages/standard-message-header","use":"$2"},{"id":"/docs/guides/exchange-fix-api/market-data-fix-api/supported-fix-messages/fix-application-level-messages/standard-message-trailer","title":"Standard message trailer","to":"/docs/guides/exchange-fix-api/market-data-fix-api/supported-fix-messages/fix-application-level-messages/standard-message-trailer","use":"$2"},{"id":"/docs/guides/exchange-fix-api/market-data-fix-api/supported-fix-messages/fix-application-level-messages/currency-pairs","title":"Currency pairs","to":"/docs/guides/exchange-fix-api/market-data-fix-api/supported-fix-messages/fix-application-level-messages/currency-pairs","use":"$2"},{"id":"/docs/guides/exchange-fix-api/market-data-fix-api/supported-fix-messages/fix-application-level-messages/message-v-market-data-request","title":"V (Market data request)","to":"/docs/guides/exchange-fix-api/market-data-fix-api/supported-fix-messages/fix-application-level-messages/message-v-market-data-request","use":"$2"},{"id":"/docs/guides/exchange-fix-api/market-data-fix-api/supported-fix-messages/fix-application-level-messages/message-w-full-refresh","title":"W (Market Data - Snapshot/Full refresh)","to":"/docs/guides/exchange-fix-api/market-data-fix-api/supported-fix-messages/fix-application-level-messages/message-w-full-refresh","use":"$2"},{"id":"/docs/guides/exchange-fix-api/market-data-fix-api/supported-fix-messages/fix-application-level-messages/message-x-incremental-refresh","title":"X (Market Data - Incremental Refresh)","to":"/docs/guides/exchange-fix-api/market-data-fix-api/supported-fix-messages/fix-application-level-messages/message-x-incremental-refresh","use":"$2"},{"id":"/docs/guides/exchange-fix-api/market-data-fix-api/supported-fix-messages/fix-application-level-messages/message-y-market-data-request-reject","title":"Y (Market Data Request Reject)","to":"/docs/guides/exchange-fix-api/market-data-fix-api/supported-fix-messages/fix-application-level-messages/message-y-market-data-request-reject","use":"$2"}]}]}]},{"id":"/docs/guides/exchange-fix-api/fix-session-management","title":"FIX session management","use":"$2","items":[{"id":"/docs/guides/exchange-fix-api/fix-session-management/starting-session-and-authentication","title":"Starting session and authentication","to":"/docs/guides/exchange-fix-api/fix-session-management/starting-session-and-authentication","use":"$2"},{"id":"/docs/guides/exchange-fix-api/fix-session-management/session-termination","title":"Session termination","to":"/docs/guides/exchange-fix-api/fix-session-management/session-termination","use":"$2"},{"id":"/docs/guides/exchange-fix-api/fix-session-management/reject-handling","title":"Reject handling","to":"/docs/guides/exchange-fix-api/fix-session-management/reject-handling","use":"$2"}]}]},{"id":"/docs/guides/manage-accounts","title":"Manage Accounts","use":"$2","root":true,"items":[{"id":"/docs/guides/manage-accounts/introduction","title":"Introduction to the Business API","to":"/docs/guides/manage-accounts/introduction","use":"$2"},{"id":"/docs/guides/manage-accounts/use-cases","title":"Use cases","use":"$2","items":[{"id":"/docs/guides/manage-accounts/use-cases/accounts-and-transactions-syncing","title":"Accounts and transactions syncing","to":"/docs/guides/manage-accounts/use-cases/accounts-and-transactions-syncing","use":"$2"},{"id":"/docs/guides/manage-accounts/use-cases/expenses-and-receipts","title":"Expenses and receipts syncing","to":"/docs/guides/manage-accounts/use-cases/expenses-and-receipts","use":"$2"},{"id":"/docs/guides/manage-accounts/use-cases/payouts-automation","title":"Payouts automation","to":"/docs/guides/manage-accounts/use-cases/payouts-automation","use":"$2"}]},{"id":"/docs/guides/manage-accounts/get-started","title":"Get started","use":"$2","items":[{"id":"/docs/guides/manage-accounts/get-started/sign-up-for-revolut-business-account","title":"1. Sign up for Revolut Business account","to":"/docs/guides/manage-accounts/get-started/sign-up-for-revolut-business-account","use":"$2"},{"id":"/docs/guides/manage-accounts/get-started/prepare-sandbox-environment","title":"2. Set up a test environment with Revolut Sandbox","to":"/docs/guides/manage-accounts/get-started/prepare-sandbox-environment","use":"$2"},{"id":"/docs/guides/manage-accounts/get-started/make-your-first-api-request","title":"3. Make your first API request","to":"/docs/guides/manage-accounts/get-started/make-your-first-api-request","use":"$2"}]},{"id":"/docs/guides/manage-accounts/accounting","title":"Accounting settings","use":"$2","items":[{"id":"/docs/guides/manage-accounts/accounting/manage-accounting-settings","title":"Overview","to":"/docs/guides/manage-accounts/accounting/manage-accounting-settings","use":"$2"},{"id":"/docs/guides/manage-accounts/accounting/manage-accounting-categories","title":"Accounting categories","to":"/docs/guides/manage-accounts/accounting/manage-accounting-categories","use":"$2"},{"id":"/docs/guides/manage-accounts/accounting/manage-tax-rates","title":"Tax rates","to":"/docs/guides/manage-accounts/accounting/manage-tax-rates","use":"$2"},{"id":"/docs/guides/manage-accounts/accounting/manage-labels-and-label-groups","title":"Labels and label groups","to":"/docs/guides/manage-accounts/accounting/manage-labels-and-label-groups","use":"$2"}]},{"id":"/docs/guides/manage-accounts/accounts-and-transactions","title":"Accounts and transactions","use":"$2","items":[{"id":"/docs/guides/manage-accounts/accounts-and-transactions/manage-your-accounts","title":"Accounts","to":"/docs/guides/manage-accounts/accounts-and-transactions/manage-your-accounts","use":"$2"},{"id":"/docs/guides/manage-accounts/accounts-and-transactions/retrieve-expenses","title":"Expenses","to":"/docs/guides/manage-accounts/accounts-and-transactions/retrieve-expenses","use":"$2"},{"id":"/docs/guides/manage-accounts/accounts-and-transactions/retrieve-transactions","title":"Transactions","to":"/docs/guides/manage-accounts/accounts-and-transactions/retrieve-transactions","use":"$2"},{"id":"/docs/guides/manage-accounts/accounts-and-transactions/map-transaction-data","title":"Map transactions","to":"/docs/guides/manage-accounts/accounts-and-transactions/map-transaction-data","use":"$2"}]},{"id":"/docs/guides/manage-accounts/counterparties","title":"Counterparties","use":"$2","items":[{"id":"/docs/guides/manage-accounts/counterparties/create-a-counterparty","title":"Create a counterparty","to":"/docs/guides/manage-accounts/counterparties/create-a-counterparty","use":"$2"},{"id":"/docs/guides/manage-accounts/counterparties/retrieve-counterparties","title":"Retrieve counterparties","to":"/docs/guides/manage-accounts/counterparties/retrieve-counterparties","use":"$2"},{"id":"/docs/guides/manage-accounts/counterparties/update-counterparty-payment-method","title":"Update a counterparty's payment method","to":"/docs/guides/manage-accounts/counterparties/update-counterparty-payment-method","use":"$2"},{"id":"/docs/guides/manage-accounts/counterparties/confirmation-of-payee","title":"Confirmation of Payee (CoP)","to":"/docs/guides/manage-accounts/counterparties/confirmation-of-payee","use":"$2"}]},{"id":"/docs/guides/manage-accounts/transfers","title":"Transfers","use":"$2","items":[{"id":"/docs/guides/manage-accounts/transfers/send-money","title":"Send money","to":"/docs/guides/manage-accounts/transfers/send-money","use":"$2"},{"id":"/docs/guides/manage-accounts/transfers/bank-transfers","title":"Bank transfers","to":"/docs/guides/manage-accounts/transfers/bank-transfers","use":"$2"},{"id":"/docs/guides/manage-accounts/transfers/card-transfers","title":"Card transfers","to":"/docs/guides/manage-accounts/transfers/card-transfers","use":"$2"},{"id":"/docs/guides/manage-accounts/transfers/payout-links","title":"Payout links","to":"/docs/guides/manage-accounts/transfers/payout-links","use":"$2"},{"id":"/docs/guides/manage-accounts/transfers/payment-drafts","title":"Payment drafts","to":"/docs/guides/manage-accounts/transfers/payment-drafts","use":"$2"},{"id":"/docs/guides/manage-accounts/transfers/prepare-and-validate-transfers","title":"Prepare and validate transfers","to":"/docs/guides/manage-accounts/transfers/prepare-and-validate-transfers","use":"$2"}]},{"id":"/docs/guides/manage-accounts/exchange-money","title":"Foreign exchange","to":"/docs/guides/manage-accounts/exchange-money","use":"$2"},{"id":"/docs/guides/manage-accounts/cards","title":"Cards","use":"$2","items":[{"id":"/docs/guides/manage-accounts/cards/manage-cards","title":"Cards","to":"/docs/guides/manage-accounts/cards/manage-cards","use":"$2"},{"id":"/docs/guides/manage-accounts/cards/manage-card-invitations","title":"Card invitations","to":"/docs/guides/manage-accounts/cards/manage-card-invitations","use":"$2"}]},{"id":"/docs/guides/manage-accounts/teams","title":"Teams","use":"$2","items":[{"id":"/docs/guides/manage-accounts/teams/manage-team-members","title":"Members and roles","to":"/docs/guides/manage-accounts/teams/manage-team-members","use":"$2"},{"id":"/docs/guides/manage-accounts/teams/manage-departments","title":"Departments","to":"/docs/guides/manage-accounts/teams/manage-departments","use":"$2"}]},{"id":"/docs/guides/manage-accounts/webhooks","title":"Webhooks","use":"$2","items":[{"id":"/docs/guides/manage-accounts/webhooks/about-webhooks","title":"About webhooks","to":"/docs/guides/manage-accounts/webhooks/about-webhooks","use":"$2"},{"id":"/docs/guides/manage-accounts/webhooks/manage-webhooks","title":"Manage webhooks","to":"/docs/guides/manage-accounts/webhooks/manage-webhooks","use":"$2"},{"id":"/docs/guides/manage-accounts/webhooks/verify-the-payload-signature","title":"Verify the payload signature","to":"/docs/guides/manage-accounts/webhooks/verify-the-payload-signature","use":"$2"}]},{"id":"/docs/guides/manage-accounts/api-usage-and-testing","title":"API usage and testing","use":"$2","items":[{"id":"/docs/guides/manage-accounts/api-usage-and-testing/errors","title":"Errors","to":"/docs/guides/manage-accounts/api-usage-and-testing/errors","use":"$2"},{"id":"/docs/guides/manage-accounts/api-usage-and-testing/usage-and-limits","title":"Usage and limits","to":"/docs/guides/manage-accounts/api-usage-and-testing/usage-and-limits","use":"$2"},{"id":"/docs/guides/manage-accounts/api-usage-and-testing/test-flows-with-simulations","title":"Test your flows with simulations (Sandbox only)","to":"/docs/guides/manage-accounts/api-usage-and-testing/test-flows-with-simulations","use":"$2"}]}]},{"id":"/docs/guides/merchant","title":"Merchant","use":"$2","root":true,"items":[{"id":"/docs/guides/merchant/introduction","title":"Introduction","to":"/docs/guides/merchant/introduction","use":"$2"},{"id":"/docs/guides/merchant/get-started","title":"Get started","to":"/docs/guides/merchant/get-started","use":"$2"},{"id":"/docs/guides/merchant/test-and-go-live","title":"Test & go live","use":"$2","items":[{"id":"/docs/guides/merchant/test-and-go-live/set-up-sandbox","title":"Set up a test environment","to":"/docs/guides/merchant/test-and-go-live/set-up-sandbox","use":"$2"},{"id":"/docs/guides/merchant/test-and-go-live/testing","title":"Testing","use":"$2","items":[{"id":"/docs/guides/merchant/test-and-go-live/testing/implementation-checklists","title":"Implementation checklist","to":"/docs/guides/merchant/test-and-go-live/testing/implementation-checklists","use":"$2"},{"id":"/docs/guides/merchant/test-and-go-live/testing/test-flows","title":"Test payment flows","to":"/docs/guides/merchant/test-and-go-live/testing/test-flows","use":"$2"},{"id":"/docs/guides/merchant/test-and-go-live/testing/test-cards","title":"Test cards","to":"/docs/guides/merchant/test-and-go-live/testing/test-cards","use":"$2"}]}]},{"id":"/docs/guides/merchant/accept-payments","title":"Accept payments","use":"$2","items":[{"id":"/docs/guides/merchant/accept-payments/online-payments","title":"Online payments","use":"$2","items":[{"id":"/docs/guides/merchant/accept-payments/online-payments/introduction","title":"Introduction","to":"/docs/guides/merchant/accept-payments/online-payments/introduction","use":"$2"},{"id":"/docs/guides/merchant/accept-payments/online-payments/revolut-checkout","title":"Revolut Checkout","use":"$2","items":[{"id":"/docs/guides/merchant/accept-payments/online-payments/revolut-checkout/introduction","title":"Introduction","to":"/docs/guides/merchant/accept-payments/online-payments/revolut-checkout/introduction","use":"$2"},{"id":"/docs/guides/merchant/accept-payments/online-payments/revolut-checkout/web","title":"Web","to":"/docs/guides/merchant/accept-payments/online-payments/revolut-checkout/web","use":"$2"}]},{"id":"/docs/guides/merchant/accept-payments/online-payments/revolut-pay","title":"Revolut Pay","use":"$2","items":[{"id":"/docs/guides/merchant/accept-payments/online-payments/revolut-pay/introduction","title":"Introduction","to":"/docs/guides/merchant/accept-payments/online-payments/revolut-pay/introduction","use":"$2"},{"id":"/docs/guides/merchant/accept-payments/online-payments/revolut-pay/web","title":"Web","to":"/docs/guides/merchant/accept-payments/online-payments/revolut-pay/web","use":"$2"},{"id":"/docs/guides/merchant/accept-payments/online-payments/revolut-pay/mobile","title":"Mobile","use":"$2","items":[{"id":"/docs/guides/merchant/accept-payments/online-payments/revolut-pay/mobile/ios","title":"iOS","to":"/docs/guides/merchant/accept-payments/online-payments/revolut-pay/mobile/ios","use":"$2"},{"id":"/docs/guides/merchant/accept-payments/online-payments/revolut-pay/mobile/android","title":"Android","to":"/docs/guides/merchant/accept-payments/online-payments/revolut-pay/mobile/android","use":"$2"},{"id":"/docs/guides/merchant/accept-payments/online-payments/revolut-pay/mobile/react-native","title":"React Native","to":"/docs/guides/merchant/accept-payments/online-payments/revolut-pay/mobile/react-native","use":"$2"}]},{"id":"/docs/guides/merchant/optimise-checkout/fast-checkout","title":"Fast checkout","use":"$2","to":"/docs/guides/merchant/optimise-checkout/fast-checkout"}]},{"id":"/docs/guides/merchant/accept-payments/online-payments/card-payments","title":"Card payments","use":"$2","items":[{"id":"/docs/guides/merchant/accept-payments/online-payments/card-payments/introduction","title":"Introduction","to":"/docs/guides/merchant/accept-payments/online-payments/card-payments/introduction","use":"$2"},{"id":"/docs/guides/merchant/accept-payments/online-payments/card-payments/web","title":"Web","use":"$2","items":[{"id":"/docs/guides/merchant/accept-payments/online-payments/card-payments/web/card-field","title":"Card field","to":"/docs/guides/merchant/accept-payments/online-payments/card-payments/web/card-field","use":"$2"},{"id":"/docs/guides/merchant/accept-payments/online-payments/card-payments/web/pop-up","title":"Card pop-up","to":"/docs/guides/merchant/accept-payments/online-payments/card-payments/web/pop-up","use":"$2"}]},{"id":"/docs/guides/merchant/accept-payments/online-payments/card-payments/mobile","title":"Mobile","use":"$2","items":[{"id":"/docs/guides/merchant/accept-payments/online-payments/card-payments/mobile/ios","title":"iOS","to":"/docs/guides/merchant/accept-payments/online-payments/card-payments/mobile/ios","use":"$2"},{"id":"/docs/guides/merchant/accept-payments/online-payments/card-payments/mobile/android","title":"Android","to":"/docs/guides/merchant/accept-payments/online-payments/card-payments/mobile/android","use":"$2"},{"id":"/docs/guides/merchant/accept-payments/online-payments/card-payments/mobile/react-native","title":"React Native","to":"/docs/guides/merchant/accept-payments/online-payments/card-payments/mobile/react-native","use":"$2"}]}]},{"id":"/docs/guides/merchant/accept-payments/online-payments/apple-pay-google-pay","title":"Apple Pay and Google Pay","use":"$2","items":[{"id":"/docs/guides/merchant/accept-payments/online-payments/apple-pay-google-pay/introduction","title":"Introduction","to":"/docs/guides/merchant/accept-payments/online-payments/apple-pay-google-pay/introduction","use":"$2"},{"id":"/docs/guides/merchant/accept-payments/online-payments/apple-pay-google-pay/web","title":"Web","to":"/docs/guides/merchant/accept-payments/online-payments/apple-pay-google-pay/web","use":"$2"},{"id":"/docs/guides/merchant/accept-payments/online-payments/apple-pay-google-pay/mobile","title":"Mobile","use":"$2","items":[{"id":"/docs/guides/merchant/accept-payments/online-payments/apple-pay-google-pay/mobile/ios","title":"iOS","to":"/docs/guides/merchant/accept-payments/online-payments/apple-pay-google-pay/mobile/ios","use":"$2"}]}]},{"id":"/docs/guides/merchant/accept-payments/online-payments/pay-by-bank","title":"Pay by Bank","use":"$2","items":[{"id":"/docs/guides/merchant/accept-payments/online-payments/pay-by-bank/introduction","title":"Introduction","to":"/docs/guides/merchant/accept-payments/online-payments/pay-by-bank/introduction","use":"$2"},{"id":"/docs/guides/merchant/accept-payments/online-payments/pay-by-bank/web","title":"Web","to":"/docs/guides/merchant/accept-payments/online-payments/pay-by-bank/web","use":"$2"}]},{"id":"/docs/guides/merchant/accept-payments/online-payments/sepa-direct-debit","title":"SEPA Direct Debit","use":"$2","items":[{"id":"/docs/guides/merchant/accept-payments/online-payments/sepa-direct-debit/introduction","title":"Introduction","to":"/docs/guides/merchant/accept-payments/online-payments/sepa-direct-debit/introduction","use":"$2"},{"id":"/docs/guides/merchant/accept-payments/online-payments/sepa-direct-debit/web","title":"Web","to":"/docs/guides/merchant/accept-payments/online-payments/sepa-direct-debit/web","use":"$2"}]},{"id":"/docs/guides/merchant/accept-payments/online-payments/click-to-pay","title":"Click to Pay","use":"$2","items":[{"id":"/docs/guides/merchant/accept-payments/online-payments/click-to-pay/introduction","title":"Introduction","to":"/docs/guides/merchant/accept-payments/online-payments/click-to-pay/introduction","use":"$2"},{"id":"/docs/guides/merchant/accept-payments/online-payments/click-to-pay/web","title":"Web","to":"/docs/guides/merchant/accept-payments/online-payments/click-to-pay/web","use":"$2"}]},{"id":"/docs/guides/merchant/accept-payments/online-payments/hosted-checkout-page","title":"Hosted Checkout Page","use":"$2","items":[{"id":"/docs/guides/merchant/accept-payments/online-payments/hosted-checkout-page/introduction","title":"Introduction","to":"/docs/guides/merchant/accept-payments/online-payments/hosted-checkout-page/introduction","use":"$2"},{"id":"/docs/guides/merchant/accept-payments/online-payments/hosted-checkout-page/payment-link","title":"Payment link","to":"/docs/guides/merchant/accept-payments/online-payments/hosted-checkout-page/payment-link","use":"$2"},{"id":"/docs/guides/merchant/accept-payments/online-payments/hosted-checkout-page/api","title":"API","to":"/docs/guides/merchant/accept-payments/online-payments/hosted-checkout-page/api","use":"$2"}]}]},{"id":"/docs/guides/merchant/accept-payments/in-person-payments","title":"In-person payments","use":"$2","items":[{"id":"/docs/guides/merchant/accept-payments/in-person-payments/introduction","title":"Introduction","to":"/docs/guides/merchant/accept-payments/in-person-payments/introduction","use":"$2"},{"id":"/docs/guides/merchant/accept-payments/in-person-payments/pos","title":"Revolut POS","use":"$2","items":[{"id":"/docs/guides/merchant/accept-payments/in-person-payments/pos/introduction","title":"Introduction","to":"/docs/guides/merchant/accept-payments/in-person-payments/pos/introduction","use":"$2"},{"id":"/docs/guides/merchant/accept-payments/in-person-payments/pos/get-started","title":"Get started","to":"/docs/guides/merchant/accept-payments/in-person-payments/pos/get-started","use":"$2"},{"id":"/docs/guides/merchant/accept-payments/in-person-payments/pos/web-app","title":"Web app","use":"$2","items":[{"id":"/docs/guides/merchant/accept-payments/in-person-payments/pos/web-app/get-started","title":"Get started","to":"/docs/guides/merchant/accept-payments/in-person-payments/pos/web-app/get-started","use":"$2"},{"id":"/docs/guides/merchant/accept-payments/in-person-payments/pos/web-app/product-management","title":"Product and catalogue management","to":"/docs/guides/merchant/accept-payments/in-person-payments/pos/web-app/product-management","use":"$2"},{"id":"/docs/guides/merchant/accept-payments/in-person-payments/pos/web-app/settings","title":"Settings","to":"/docs/guides/merchant/accept-payments/in-person-payments/pos/web-app/settings","use":"$2"},{"id":"/docs/guides/merchant/accept-payments/in-person-payments/pos/web-app/staff-management","title":"Staff management","to":"/docs/guides/merchant/accept-payments/in-person-payments/pos/web-app/staff-management","use":"$2"},{"id":"/docs/guides/merchant/accept-payments/in-person-payments/pos/web-app/analytics-orders","title":"Analytics and orders","to":"/docs/guides/merchant/accept-payments/in-person-payments/pos/web-app/analytics-orders","use":"$2"}]},{"id":"/docs/guides/merchant/accept-payments/in-person-payments/pos/ios-app","title":"iOS app","use":"$2","items":[{"id":"/docs/guides/merchant/accept-payments/in-person-payments/pos/ios-app/get-started","title":"Get started","to":"/docs/guides/merchant/accept-payments/in-person-payments/pos/ios-app/get-started","use":"$2"},{"id":"/docs/guides/merchant/accept-payments/in-person-payments/pos/ios-app/order-management","title":"Order management","to":"/docs/guides/merchant/accept-payments/in-person-payments/pos/ios-app/order-management","use":"$2"},{"id":"/docs/guides/merchant/accept-payments/in-person-payments/pos/ios-app/table-service","title":"Table service","to":"/docs/guides/merchant/accept-payments/in-person-payments/pos/ios-app/table-service","use":"$2"},{"id":"/docs/guides/merchant/accept-payments/in-person-payments/pos/ios-app/catalogue","title":"Catalogue","to":"/docs/guides/merchant/accept-payments/in-person-payments/pos/ios-app/catalogue","use":"$2"},{"id":"/docs/guides/merchant/accept-payments/in-person-payments/pos/ios-app/operational-settings","title":"Operational settings","to":"/docs/guides/merchant/accept-payments/in-person-payments/pos/ios-app/operational-settings","use":"$2"},{"id":"/docs/guides/merchant/accept-payments/in-person-payments/pos/ios-app/hardware-settings","title":"Hardware settings","to":"/docs/guides/merchant/accept-payments/in-person-payments/pos/ios-app/hardware-settings","use":"$2"},{"id":"/docs/guides/merchant/accept-payments/in-person-payments/pos/ios-app/reports","title":"Reports","to":"/docs/guides/merchant/accept-payments/in-person-payments/pos/ios-app/reports","use":"$2"}]},{"id":"/docs/guides/merchant/accept-payments/in-person-payments/pos/order-pay","title":"Order and Pay","to":"/docs/guides/merchant/accept-payments/in-person-payments/pos/order-pay","use":"$2"},{"id":"/docs/guides/merchant/accept-payments/in-person-payments/pos/support","title":"Support","to":"/docs/guides/merchant/accept-payments/in-person-payments/pos/support","use":"$2"},{"id":"/docs/guides/merchant/accept-payments/in-person-payments/pos/faq","title":"FAQs","to":"/docs/guides/merchant/accept-payments/in-person-payments/pos/faq","use":"$2"}]},{"id":"/docs/guides/merchant/accept-payments/in-person-payments/terminal","title":"Revolut Terminal","use":"$2","items":[{"id":"/docs/guides/merchant/accept-payments/in-person-payments/terminal/introduction","title":"Introduction","to":"/docs/guides/merchant/accept-payments/in-person-payments/terminal/introduction","use":"$2"},{"id":"/docs/guides/merchant/accept-payments/in-person-payments/terminal/get-started","title":"Get started","to":"/docs/guides/merchant/accept-payments/in-person-payments/terminal/get-started","use":"$2"},{"id":"/docs/guides/merchant/accept-payments/in-person-payments/terminal/manage-payments","title":"Manage payments","to":"/docs/guides/merchant/accept-payments/in-person-payments/terminal/manage-payments","use":"$2"},{"id":"/docs/guides/merchant/accept-payments/in-person-payments/terminal/additional-features","title":"Additional features","to":"/docs/guides/merchant/accept-payments/in-person-payments/terminal/additional-features","use":"$2"},{"id":"/docs/guides/merchant/accept-payments/in-person-payments/terminal/push-payments","title":"Push payments to Revolut Terminal","to":"/docs/guides/merchant/accept-payments/in-person-payments/terminal/push-payments","use":"$2"},{"id":"/docs/guides/merchant/accept-payments/in-person-payments/terminal/pre-authorisation","title":"Pre-authorisation","to":"/docs/guides/merchant/accept-payments/in-person-payments/terminal/pre-authorisation","use":"$2"},{"id":"/docs/guides/merchant/accept-payments/in-person-payments/terminal/support-warranty","title":"Support and warranty","to":"/docs/guides/merchant/accept-payments/in-person-payments/terminal/support-warranty","use":"$2"}]},{"id":"/docs/guides/merchant/accept-payments/in-person-payments/reader","title":"Revolut Reader","use":"$2","items":[{"id":"/docs/guides/merchant/accept-payments/in-person-payments/reader/introduction","title":"Introduction","to":"/docs/guides/merchant/accept-payments/in-person-payments/reader/introduction","use":"$2"},{"id":"/docs/guides/merchant/accept-payments/in-person-payments/reader/get-started","title":"Get started","to":"/docs/guides/merchant/accept-payments/in-person-payments/reader/get-started","use":"$2"},{"id":"/docs/guides/merchant/accept-payments/in-person-payments/reader/manage-payments","title":"Manage payments","to":"/docs/guides/merchant/accept-payments/in-person-payments/reader/manage-payments","use":"$2"},{"id":"/docs/guides/merchant/accept-payments/in-person-payments/reader/additional-features","title":"Additional features","to":"/docs/guides/merchant/accept-payments/in-person-payments/reader/additional-features","use":"$2"},{"id":"/docs/guides/merchant/accept-payments/in-person-payments/reader/support-warranty","title":"Support and warranty","to":"/docs/guides/merchant/accept-payments/in-person-payments/reader/support-warranty","use":"$2"},{"id":"/docs/guides/merchant/accept-payments/in-person-payments/reader/faq","title":"FAQs","to":"/docs/guides/merchant/accept-payments/in-person-payments/reader/faq","use":"$2"}]},{"id":"/docs/guides/merchant/accept-payments/in-person-payments/tap-to-pay","title":"Tap to Pay","use":"$2","items":[{"id":"/docs/guides/merchant/accept-payments/in-person-payments/tap-to-pay/introduction","title":"Introduction","to":"/docs/guides/merchant/accept-payments/in-person-payments/tap-to-pay/introduction","use":"$2"},{"id":"/docs/guides/merchant/accept-payments/in-person-payments/tap-to-pay/get-started","title":"Get started","to":"/docs/guides/merchant/accept-payments/in-person-payments/tap-to-pay/get-started","use":"$2"},{"id":"/docs/guides/merchant/accept-payments/in-person-payments/tap-to-pay/integration-guide","title":"Integration guide","to":"/docs/guides/merchant/accept-payments/in-person-payments/tap-to-pay/integration-guide","use":"$2"}]}]},{"id":"/docs/guides/merchant/accept-payments/no-code","title":"No-code integrations","use":"$2","items":[{"id":"/docs/guides/merchant/accept-payments/no-code/plugins","title":"E-commerce plugins","use":"$2","items":[{"id":"/docs/guides/merchant/accept-payments/no-code/plugins/introduction","title":"Introduction","to":"/docs/guides/merchant/accept-payments/no-code/plugins/introduction","use":"$2"},{"id":"/docs/guides/merchant/accept-payments/no-code/plugins/woocommerce","title":"WooCommerce","use":"$2","items":[{"id":"/docs/guides/merchant/accept-payments/no-code/plugins/woocommerce/introduction","title":"Introduction","to":"/docs/guides/merchant/accept-payments/no-code/plugins/woocommerce/introduction","use":"$2"},{"id":"/docs/guides/merchant/accept-payments/no-code/plugins/woocommerce/installation","title":"Installation","to":"/docs/guides/merchant/accept-payments/no-code/plugins/woocommerce/installation","use":"$2"},{"id":"/docs/guides/merchant/accept-payments/no-code/plugins/woocommerce/configuration","title":"Configuration","to":"/docs/guides/merchant/accept-payments/no-code/plugins/woocommerce/configuration","use":"$2"},{"id":"/docs/guides/merchant/accept-payments/no-code/plugins/woocommerce/features","title":"Features and operations","to":"/docs/guides/merchant/accept-payments/no-code/plugins/woocommerce/features","use":"$2"}]},{"id":"/docs/guides/merchant/accept-payments/no-code/plugins/prestashop","title":"PrestaShop","use":"$2","items":[{"id":"/docs/guides/merchant/accept-payments/no-code/plugins/prestashop/introduction","title":"Introduction","to":"/docs/guides/merchant/accept-payments/no-code/plugins/prestashop/introduction","use":"$2"},{"id":"/docs/guides/merchant/accept-payments/no-code/plugins/prestashop/installation","title":"Installation","to":"/docs/guides/merchant/accept-payments/no-code/plugins/prestashop/installation","use":"$2"},{"id":"/docs/guides/merchant/accept-payments/no-code/plugins/prestashop/configuration","title":"Configuration","to":"/docs/guides/merchant/accept-payments/no-code/plugins/prestashop/configuration","use":"$2"},{"id":"/docs/guides/merchant/accept-payments/no-code/plugins/prestashop/features","title":"Features and operations","to":"/docs/guides/merchant/accept-payments/no-code/plugins/prestashop/features","use":"$2"}]},{"id":"/docs/guides/merchant/accept-payments/no-code/plugins/magento","title":"Adobe Commerce (Magento 2)","use":"$2","items":[{"id":"/docs/guides/merchant/accept-payments/no-code/plugins/magento/introduction","title":"Introduction","to":"/docs/guides/merchant/accept-payments/no-code/plugins/magento/introduction","use":"$2"},{"id":"/docs/guides/merchant/accept-payments/no-code/plugins/magento/installation","title":"Installation","to":"/docs/guides/merchant/accept-payments/no-code/plugins/magento/installation","use":"$2"},{"id":"/docs/guides/merchant/accept-payments/no-code/plugins/magento/configuration","title":"Configuration","to":"/docs/guides/merchant/accept-payments/no-code/plugins/magento/configuration","use":"$2"},{"id":"/docs/guides/merchant/accept-payments/no-code/plugins/magento/features","title":"Features and operations","to":"/docs/guides/merchant/accept-payments/no-code/plugins/magento/features","use":"$2"}]},{"id":"/docs/guides/merchant/accept-payments/no-code/plugins/bigcommerce","title":"BigCommerce","use":"$2","items":[{"id":"/docs/guides/merchant/accept-payments/no-code/plugins/bigcommerce/introduction","title":"Introduction","to":"/docs/guides/merchant/accept-payments/no-code/plugins/bigcommerce/introduction","use":"$2"},{"id":"/docs/guides/merchant/accept-payments/no-code/plugins/bigcommerce/installation","title":"Installation","to":"/docs/guides/merchant/accept-payments/no-code/plugins/bigcommerce/installation","use":"$2"},{"id":"/docs/guides/merchant/accept-payments/no-code/plugins/bigcommerce/configuration","title":"Configuration","to":"/docs/guides/merchant/accept-payments/no-code/plugins/bigcommerce/configuration","use":"$2"},{"id":"/docs/guides/merchant/accept-payments/no-code/plugins/bigcommerce/features","title":"Features and operations","to":"/docs/guides/merchant/accept-payments/no-code/plugins/bigcommerce/features","use":"$2"}]},{"id":"/docs/guides/merchant/accept-payments/no-code/plugins/shopify","title":"Shopify","use":"$2","items":[{"id":"/docs/guides/merchant/accept-payments/no-code/plugins/shopify/introduction","title":"Introduction","to":"/docs/guides/merchant/accept-payments/no-code/plugins/shopify/introduction","use":"$2"},{"id":"/docs/guides/merchant/accept-payments/no-code/plugins/shopify/installation","title":"Installation","to":"/docs/guides/merchant/accept-payments/no-code/plugins/shopify/installation","use":"$2"},{"id":"/docs/guides/merchant/accept-payments/no-code/plugins/shopify/configuration","title":"Configuration","to":"/docs/guides/merchant/accept-payments/no-code/plugins/shopify/configuration","use":"$2"},{"id":"/docs/guides/merchant/accept-payments/no-code/plugins/shopify/features","title":"Features and operations","to":"/docs/guides/merchant/accept-payments/no-code/plugins/shopify/features","use":"$2"}]},{"id":"/docs/guides/merchant/accept-payments/no-code/plugins/opencart","title":"OpenCart","use":"$2","items":[{"id":"/docs/guides/merchant/accept-payments/no-code/plugins/opencart/introduction","title":"Introduction","to":"/docs/guides/merchant/accept-payments/no-code/plugins/opencart/introduction","use":"$2"},{"id":"/docs/guides/merchant/accept-payments/no-code/plugins/opencart/installation","title":"Installation","to":"/docs/guides/merchant/accept-payments/no-code/plugins/opencart/installation","use":"$2"},{"id":"/docs/guides/merchant/accept-payments/no-code/plugins/opencart/configuration","title":"Configuration","to":"/docs/guides/merchant/accept-payments/no-code/plugins/opencart/configuration","use":"$2"},{"id":"/docs/guides/merchant/accept-payments/no-code/plugins/opencart/features","title":"Features and operations","to":"/docs/guides/merchant/accept-payments/no-code/plugins/opencart/features","use":"$2"}]}]},{"id":"/docs/guides/merchant/accept-payments/online-payments/hosted-checkout-page/payment-link","title":"Payment links","use":"$2","to":"/docs/guides/merchant/accept-payments/online-payments/hosted-checkout-page/payment-link"},{"id":"/docs/guides/merchant/accept-payments/no-code/invoices","title":"Invoices","use":"$2","items":[{"id":"/docs/guides/merchant/accept-payments/no-code/invoices/xero","title":"Xero invoices","use":"$2","items":[{"id":"/docs/guides/merchant/accept-payments/no-code/invoices/xero/configuration","title":"Configuration","to":"/docs/guides/merchant/accept-payments/no-code/invoices/xero/configuration","use":"$2"},{"id":"/docs/guides/merchant/accept-payments/no-code/invoices/xero/troubleshooting","title":"Troubleshooting","to":"/docs/guides/merchant/accept-payments/no-code/invoices/xero/troubleshooting","use":"$2"}]}]}]}]},{"id":"/docs/guides/merchant/billing-subscriptions","title":"Billing & subscriptions","use":"$2","items":[{"id":"/docs/guides/merchant/billing-subscriptions/introduction","title":"Introduction","to":"/docs/guides/merchant/billing-subscriptions/introduction","use":"$2"},{"id":"/docs/guides/merchant/billing-subscriptions/subscription-plans","title":"Subscription plans","to":"/docs/guides/merchant/billing-subscriptions/subscription-plans","use":"$2"},{"id":"/docs/guides/merchant/billing-subscriptions/subscription-lifecycle","title":"Subscription lifecycle","to":"/docs/guides/merchant/billing-subscriptions/subscription-lifecycle","use":"$2"},{"id":"/docs/guides/merchant/billing-subscriptions/api","title":"API","use":"$2","items":[{"id":"/docs/guides/merchant/billing-subscriptions/api/introduction","title":"Introduction","to":"/docs/guides/merchant/billing-subscriptions/api/introduction","use":"$2"},{"id":"/docs/guides/merchant/billing-subscriptions/api/get-started","title":"Get started","to":"/docs/guides/merchant/billing-subscriptions/api/get-started","use":"$2"},{"id":"/docs/guides/merchant/billing-subscriptions/api/fixed","title":"Fixed-rate subscription","to":"/docs/guides/merchant/billing-subscriptions/api/fixed","use":"$2"},{"id":"/docs/guides/merchant/billing-subscriptions/api/per-seat","title":"Per-seat subscription","to":"/docs/guides/merchant/billing-subscriptions/api/per-seat","use":"$2"},{"id":"/docs/guides/merchant/billing-subscriptions/api/usage-based","title":"Usage-based subscription","to":"/docs/guides/merchant/billing-subscriptions/api/usage-based","use":"$2"},{"id":"/docs/guides/merchant/billing-subscriptions/api/trials","title":"Trials & introductory pricing","to":"/docs/guides/merchant/billing-subscriptions/api/trials","use":"$2"},{"id":"/docs/guides/merchant/billing-subscriptions/api/webhooks","title":"Webhooks","to":"/docs/guides/merchant/billing-subscriptions/api/webhooks","use":"$2"}]}]},{"id":"/docs/guides/merchant/operations","title":"Operations","use":"$2","items":[{"id":"/docs/guides/merchant/operations/capture-and-settlement","title":"Capture & settlement","use":"$2","items":[{"id":"/docs/guides/merchant/operations/capture-and-settlement/capture-later","title":"Authorise a payment to capture later","to":"/docs/guides/merchant/operations/capture-and-settlement/capture-later","use":"$2"},{"id":"/docs/guides/merchant/operations/capture-and-settlement/advanced-authorisation","title":"Advanced authorisation","use":"$2","items":[{"id":"/docs/guides/merchant/operations/capture-and-settlement/advanced-authorisation/introduction","title":"Introduction","to":"/docs/guides/merchant/operations/capture-and-settlement/advanced-authorisation/introduction","use":"$2"},{"id":"/docs/guides/merchant/operations/capture-and-settlement/advanced-authorisation/pre-authorisation","title":"Pre-authorisation","to":"/docs/guides/merchant/operations/capture-and-settlement/advanced-authorisation/pre-authorisation","use":"$2"},{"id":"/docs/guides/merchant/operations/capture-and-settlement/advanced-authorisation/incremental-authorisation","title":"Incremental authorisation","to":"/docs/guides/merchant/operations/capture-and-settlement/advanced-authorisation/incremental-authorisation","use":"$2"},{"id":"/docs/guides/merchant/operations/capture-and-settlement/advanced-authorisation/clearing-windows","title":"Clearing windows","to":"/docs/guides/merchant/operations/capture-and-settlement/advanced-authorisation/clearing-windows","use":"$2"}]}]},{"id":"/docs/guides/merchant/operations/refunds","title":"Refund payments","to":"/docs/guides/merchant/operations/refunds","use":"$2"},{"id":"/docs/guides/merchant/operations/payment-method-migration","title":"Payment method migration","to":"/docs/guides/merchant/operations/payment-method-migration","use":"$2"}]},{"id":"/docs/guides/merchant/optimise-checkout","title":"Optimise checkout","use":"$2","items":[{"id":"/docs/guides/merchant/optimise-checkout/save-payment-methods","title":"Save and charge payment methods","use":"$2","items":[{"id":"/docs/guides/merchant/optimise-checkout/save-payment-methods/charge-saved-payment-method","title":"Charge a customer's saved payment method","to":"/docs/guides/merchant/optimise-checkout/save-payment-methods/charge-saved-payment-method","use":"$2"},{"id":"/docs/guides/merchant/optimise-checkout/save-payment-methods/checkout-with-saved-card","title":"Save cards and speed up checkout","to":"/docs/guides/merchant/optimise-checkout/save-payment-methods/checkout-with-saved-card","use":"$2"},{"id":"/docs/guides/merchant/optimise-checkout/save-payment-methods/subscription-management","title":"Manage subscriptions","to":"/docs/guides/merchant/optimise-checkout/save-payment-methods/subscription-management","use":"$2"}]},{"id":"/docs/guides/merchant/optimise-checkout/fast-checkout","title":"Fast checkout","to":"/docs/guides/merchant/optimise-checkout/fast-checkout","use":"$2"},{"id":"/docs/guides/merchant/optimise-checkout/promo-banners","title":"Add Promotional banner to your checkout page","to":"/docs/guides/merchant/optimise-checkout/promo-banners","use":"$2"}]},{"id":"/docs/guides/merchant/monitor-and-observe","title":"Monitor & observe","use":"$2","items":[{"id":"/docs/guides/merchant/monitor-and-observe/reports-reconciliation","title":"Create CSV reports of transactions","to":"/docs/guides/merchant/monitor-and-observe/reports-reconciliation","use":"$2"},{"id":"/docs/guides/merchant/monitor-and-observe/webhooks","title":"Work with webhooks","use":"$2","items":[{"id":"/docs/guides/merchant/monitor-and-observe/webhooks/using-webhooks","title":"Use webhooks to track order and payment lifecycle","to":"/docs/guides/merchant/monitor-and-observe/webhooks/using-webhooks","use":"$2"},{"id":"/docs/guides/merchant/monitor-and-observe/webhooks/verify-the-payload-signature","title":"Verify the payload signature","to":"/docs/guides/merchant/monitor-and-observe/webhooks/verify-the-payload-signature","use":"$2"}]}]},{"id":"/docs/guides/merchant/reference","title":"Reference","use":"$2","items":[{"id":"/docs/guides/merchant/reference/versioning","title":"Versioning","use":"$2","items":[{"id":"/docs/guides/merchant/reference/versioning/api-versions","title":"API versions","to":"/docs/guides/merchant/reference/versioning/api-versions","use":"$2"},{"id":"/docs/guides/merchant/reference/versioning/deprecation-policy","title":"Deprecation policy","to":"/docs/guides/merchant/reference/versioning/deprecation-policy","use":"$2"},{"id":"/docs/guides/merchant/reference/versioning/changelog","title":"Changelog","to":"/docs/guides/merchant/reference/versioning/changelog","use":"$2"}]},{"id":"/docs/api/merchant","title":"API","use":"$2","to":"/docs/api/merchant"},{"id":"/docs/guides/merchant/reference/sdks","title":"SDKs","use":"$2","items":[{"id":"/docs/sdks/merchant-web-sdk/introduction","title":"Web SDK","use":"$2","to":"/docs/sdks/merchant-web-sdk/introduction"},{"id":"/docs/sdks/merchant-ios-sdk/introduction","title":"iOS SDK","use":"$2","to":"/docs/sdks/merchant-ios-sdk/introduction"},{"id":"/docs/sdks/merchant-android-sdk/introduction","title":"Android SDK","use":"$2","to":"/docs/sdks/merchant-android-sdk/introduction"}]},{"id":"/docs/guides/merchant/reference/3d-secure","title":"3D Secure","to":"/docs/guides/merchant/reference/3d-secure","use":"$2"},{"id":"/docs/guides/merchant/reference/error-codes","title":"Errors","use":"$2","items":[{"id":"/docs/guides/merchant/reference/error-codes/http-response-errors","title":"HTTP response errors","to":"/docs/guides/merchant/reference/error-codes/http-response-errors","use":"$2"},{"id":"/docs/guides/merchant/reference/error-codes/decline-reasons","title":"Decline reasons","to":"/docs/guides/merchant/reference/error-codes/decline-reasons","use":"$2"}]},{"id":"/docs/guides/merchant/reference/order-lifecycle","title":"Order and payment lifecycle","to":"/docs/guides/merchant/reference/order-lifecycle","use":"$2"}]},{"id":"/blog","title":"Updates","use":"$2","to":"/blog"}]},{"id":"/docs/guides/revolut-wallet","title":"Revolut Wallet","use":"$2","root":true,"items":[{"id":"/docs/guides/revolut-wallet/introduction","title":"Introduction","to":"/docs/guides/revolut-wallet/introduction","use":"$2"},{"id":"/docs/guides/revolut-wallet/get-started","title":"Get started","to":"/docs/guides/revolut-wallet/get-started","use":"$2"},{"id":"/docs/guides/revolut-wallet/operations","title":"Operations","use":"$2","items":[{"id":"/docs/guides/revolut-wallet/operations/introduction","title":"Introduction","to":"/docs/guides/revolut-wallet/operations/introduction","use":"$2"},{"id":"/docs/guides/revolut-wallet/operations/create-pass","title":"Create a pass","to":"/docs/guides/revolut-wallet/operations/create-pass","use":"$2"},{"id":"/docs/guides/revolut-wallet/operations/update-pass","title":"Update a pass","to":"/docs/guides/revolut-wallet/operations/update-pass","use":"$2"},{"id":"/docs/guides/revolut-wallet/operations/transaction-results","title":"Transaction results","to":"/docs/guides/revolut-wallet/operations/transaction-results","use":"$2"}]}]},{"id":"/docs/resources","title":"Resources","use":"$2","root":true,"items":[{"id":"/docs/resources/marketing-guidelines","title":"Revolut Pay marketing assets and guidelines","to":"/docs/resources/marketing-guidelines","use":"$2"},{"id":"/docs/resources/revolut-pay-button-guidelines","title":"Revolut Pay button guidelines","to":"/docs/resources/revolut-pay-button-guidelines","use":"$2"},{"id":"/docs/resources/open-banking-logo-guidelines","title":"Revolut Open Banking logo assets and guidelines","to":"/docs/resources/open-banking-logo-guidelines","use":"$2"}]},{"id":"/docs/sdks/merchant-android-sdk","title":"Merchant Android SDK","use":"$2","root":true,"items":[{"id":"/docs/sdks/merchant-android-sdk/introduction","title":"Introduction","to":"/docs/sdks/merchant-android-sdk/introduction","use":"$2"},{"id":"/docs/sdks/merchant-android-sdk/revolut-pay-android-sdk","title":"Revolut Pay SDK","use":"$2","items":[{"id":"/docs/sdks/merchant-android-sdk/revolut-pay-android-sdk/introduction","title":"Introduction","to":"/docs/sdks/merchant-android-sdk/revolut-pay-android-sdk/introduction","use":"$2"},{"id":"/docs/sdks/merchant-android-sdk/revolut-pay-android-sdk/methods-parameters","title":"Methods and parameters","to":"/docs/sdks/merchant-android-sdk/revolut-pay-android-sdk/methods-parameters","use":"$2"}]},{"id":"/docs/sdks/merchant-android-sdk/revolut-card-form-android-sdk","title":"Revolut Card Form SDK","use":"$2","items":[{"id":"/docs/sdks/merchant-android-sdk/revolut-card-form-android-sdk/introduction","title":"Introduction","to":"/docs/sdks/merchant-android-sdk/revolut-card-form-android-sdk/introduction","use":"$2"},{"id":"/docs/sdks/merchant-android-sdk/revolut-card-form-android-sdk/methods-parameters","title":"Methods and parameters","to":"/docs/sdks/merchant-android-sdk/revolut-card-form-android-sdk/methods-parameters","use":"$2"}]}]},{"id":"/docs/sdks/merchant-ios-sdk","title":"Merchant iOS SDK","use":"$2","root":true,"items":[{"id":"/docs/sdks/merchant-ios-sdk/introduction","title":"Introduction","to":"/docs/sdks/merchant-ios-sdk/introduction","use":"$2"},{"id":"/docs/sdks/merchant-ios-sdk/revolut-pay-ios-sdk","title":"Revolut Pay SDK","use":"$2","items":[{"id":"/docs/sdks/merchant-ios-sdk/revolut-pay-ios-sdk/introduction","title":"Introduction","to":"/docs/sdks/merchant-ios-sdk/revolut-pay-ios-sdk/introduction","use":"$2"},{"id":"/docs/sdks/merchant-ios-sdk/revolut-pay-ios-sdk/methods-parameters","title":"Methods and parameters","to":"/docs/sdks/merchant-ios-sdk/revolut-pay-ios-sdk/methods-parameters","use":"$2"}]},{"id":"/docs/sdks/merchant-ios-sdk/apple-pay-ios-sdk","title":"Apple Pay SDK","use":"$2","items":[{"id":"/docs/sdks/merchant-ios-sdk/apple-pay-ios-sdk/introduction","title":"Introduction","to":"/docs/sdks/merchant-ios-sdk/apple-pay-ios-sdk/introduction","use":"$2"},{"id":"/docs/sdks/merchant-ios-sdk/apple-pay-ios-sdk/methods-parameters","title":"Methods and parameters","to":"/docs/sdks/merchant-ios-sdk/apple-pay-ios-sdk/methods-parameters","use":"$2"}]},{"id":"/docs/sdks/merchant-ios-sdk/tap-to-pay-sdk","title":"Tap to Pay SDK","use":"$2","items":[{"id":"/docs/sdks/merchant-ios-sdk/tap-to-pay-sdk/introduction","title":"Introduction","to":"/docs/sdks/merchant-ios-sdk/tap-to-pay-sdk/introduction","use":"$2"},{"id":"/docs/sdks/merchant-ios-sdk/tap-to-pay-sdk/methods-parameters","title":"Methods and parameters","to":"/docs/sdks/merchant-ios-sdk/tap-to-pay-sdk/methods-parameters","use":"$2"}]},{"id":"/docs/sdks/merchant-ios-sdk/revolut-card-form-ios-sdk","title":"Revolut Card Form SDK","use":"$2","items":[{"id":"/docs/sdks/merchant-ios-sdk/revolut-card-form-ios-sdk/introduction","title":"Introduction","to":"/docs/sdks/merchant-ios-sdk/revolut-card-form-ios-sdk/introduction","use":"$2"},{"id":"/docs/sdks/merchant-ios-sdk/revolut-card-form-ios-sdk/methods-parameters","title":"Methods and parameters","to":"/docs/sdks/merchant-ios-sdk/revolut-card-form-ios-sdk/methods-parameters","use":"$2"}]}]},{"id":"/docs/sdks/merchant-web-sdk","title":"Merchant Web SDK","use":"$2","root":true,"items":[{"id":"/docs/sdks/merchant-web-sdk/introduction","title":"Introduction","to":"/docs/sdks/merchant-web-sdk/introduction","use":"$2"},{"id":"/docs/sdks/merchant-web-sdk/get-started","title":"Get started","to":"/docs/sdks/merchant-web-sdk/get-started","use":"$2"},{"id":"/docs/sdks/merchant-web-sdk/initialisation","title":"Initialisation","use":"$2","items":[{"id":"/docs/sdks/merchant-web-sdk/initialisation/token-based","title":"Token-based initialisation","to":"/docs/sdks/merchant-web-sdk/initialisation/token-based","use":"$2"},{"id":"/docs/sdks/merchant-web-sdk/initialisation/direct","title":"Direct initialisation","to":"/docs/sdks/merchant-web-sdk/initialisation/direct","use":"$2"},{"id":"/docs/sdks/merchant-web-sdk/initialisation/payments-module","title":"Payments module initialisation","to":"/docs/sdks/merchant-web-sdk/initialisation/payments-module","use":"$2"},{"id":"/docs/sdks/merchant-web-sdk/initialisation/upsell-module","title":"Upsell module initialisation","to":"/docs/sdks/merchant-web-sdk/initialisation/upsell-module","use":"$2"}]},{"id":"/docs/sdks/merchant-web-sdk/payment-methods","title":"Payment methods","use":"$2","items":[{"id":"/docs/sdks/merchant-web-sdk/payment-methods/introduction","title":"Introduction","to":"/docs/sdks/merchant-web-sdk/payment-methods/introduction","use":"$2"},{"id":"/docs/sdks/merchant-web-sdk/payment-methods/embedded-checkout","title":"Embedded checkout","to":"/docs/sdks/merchant-web-sdk/payment-methods/embedded-checkout","use":"$2"},{"id":"/docs/sdks/merchant-web-sdk/payment-methods/revolut-pay","title":"Revolut Pay","to":"/docs/sdks/merchant-web-sdk/payment-methods/revolut-pay","use":"$2"},{"id":"/docs/sdks/merchant-web-sdk/payment-methods/apple-pay-google-pay","title":"Apple Pay / Google Pay","to":"/docs/sdks/merchant-web-sdk/payment-methods/apple-pay-google-pay","use":"$2"},{"id":"/docs/sdks/merchant-web-sdk/payment-methods/card-field","title":"Card field","to":"/docs/sdks/merchant-web-sdk/payment-methods/card-field","use":"$2"},{"id":"/docs/sdks/merchant-web-sdk/payment-methods/pop-up","title":"Card pop-up","to":"/docs/sdks/merchant-web-sdk/payment-methods/pop-up","use":"$2"},{"id":"/docs/sdks/merchant-web-sdk/payment-methods/pay-by-bank","title":"Pay by Bank","to":"/docs/sdks/merchant-web-sdk/payment-methods/pay-by-bank","use":"$2"},{"id":"/docs/sdks/merchant-web-sdk/payment-methods/sepa-direct-debit","title":"SEPA Direct Debit","to":"/docs/sdks/merchant-web-sdk/payment-methods/sepa-direct-debit","use":"$2"},{"id":"/docs/sdks/merchant-web-sdk/payment-methods/click-to-pay","title":"Click to Pay","to":"/docs/sdks/merchant-web-sdk/payment-methods/click-to-pay","use":"$2"}]},{"id":"/docs/sdks/merchant-web-sdk/promotional-widgets","title":"Promotional widgets","use":"$2","items":[{"id":"/docs/sdks/merchant-web-sdk/promotional-widgets/introduction","title":"Introduction","to":"/docs/sdks/merchant-web-sdk/promotional-widgets/introduction","use":"$2"},{"id":"/docs/sdks/merchant-web-sdk/promotional-widgets/card-gateway-banner","title":"Card gateway banner","to":"/docs/sdks/merchant-web-sdk/promotional-widgets/card-gateway-banner","use":"$2"},{"id":"/docs/sdks/merchant-web-sdk/promotional-widgets/promotional-banner","title":"Promotional banner","to":"/docs/sdks/merchant-web-sdk/promotional-widgets/promotional-banner","use":"$2"},{"id":"/docs/sdks/merchant-web-sdk/promotional-widgets/enrollment-confirmation-banner","title":"Enrollment confirmation banner","to":"/docs/sdks/merchant-web-sdk/promotional-widgets/enrollment-confirmation-banner","use":"$2"}]},{"id":"/docs/sdks/merchant-web-sdk/types","title":"Types","use":"$2","items":[{"id":"/docs/sdks/merchant-web-sdk/types/introduction","title":"Introduction","to":"/docs/sdks/merchant-web-sdk/types/introduction","use":"$2"},{"id":"/docs/sdks/merchant-web-sdk/types/locale","title":"Locale","to":"/docs/sdks/merchant-web-sdk/types/locale","use":"$2"},{"id":"/docs/sdks/merchant-web-sdk/types/address","title":"Address","to":"/docs/sdks/merchant-web-sdk/types/address","use":"$2"},{"id":"/docs/sdks/merchant-web-sdk/types/customer-details","title":"CustomerDetails","to":"/docs/sdks/merchant-web-sdk/types/customer-details","use":"$2"},{"id":"/docs/sdks/merchant-web-sdk/types/revolut-checkout-error","title":"RevolutCheckoutError","to":"/docs/sdks/merchant-web-sdk/types/revolut-checkout-error","use":"$2"},{"id":"/docs/sdks/merchant-web-sdk/types/validation-error","title":"ValidationError","to":"/docs/sdks/merchant-web-sdk/types/validation-error","use":"$2"}]},{"id":"/docs/sdks/merchant-web-sdk/integration-examples","title":"Integration examples","to":"/docs/sdks/merchant-web-sdk/integration-examples","use":"$2"}]},{"id":"/docs/sdks/reverywhere-web-sdk","title":"RevEverywhere Web SDK","use":"$2","root":true,"items":[{"id":"/docs/sdks/reverywhere-web-sdk/introduction-and-setup","title":"Introduction and setup","to":"/docs/sdks/reverywhere-web-sdk/introduction-and-setup","use":"$2"}]},{"id":"/docs/sdks/revolut-id-sdk","title":"Revolut ID SDK","use":"$2","root":true,"items":[{"id":"/docs/sdks/revolut-id-sdk/introduction","title":"Introduction","to":"/docs/sdks/revolut-id-sdk/introduction","use":"$2"},{"id":"/docs/sdks/revolut-id-sdk/web","title":"Web","use":"$2","items":[{"id":"/docs/sdks/revolut-id-sdk/web/introduction","title":"Introduction","to":"/docs/sdks/revolut-id-sdk/web/introduction","use":"$2"},{"id":"/docs/sdks/revolut-id-sdk/web/configure-client","title":"Configure client","to":"/docs/sdks/revolut-id-sdk/web/configure-client","use":"$2"},{"id":"/docs/sdks/revolut-id-sdk/web/integrate-sdk","title":"Integrate SDK","use":"$2","items":[{"id":"/docs/sdks/revolut-id-sdk/web/integrate-sdk/java-script","title":"JavaScript","to":"/docs/sdks/revolut-id-sdk/web/integrate-sdk/java-script","use":"$2"},{"id":"/docs/sdks/revolut-id-sdk/web/integrate-sdk/react","title":"React","to":"/docs/sdks/revolut-id-sdk/web/integrate-sdk/react","use":"$2"}]},{"id":"/docs/sdks/revolut-id-sdk/web/code-exchange","title":"Code exchange","to":"/docs/sdks/revolut-id-sdk/web/code-exchange","use":"$2"},{"id":"/docs/sdks/revolut-id-sdk/web/api-reference","title":"API reference","use":"$2","to":"/docs/sdks/revolut-id-sdk/web/api-reference","items":[{"id":"/docs/sdks/revolut-id-sdk/web/api-reference/revolut-id","title":"RevolutId","to":"/docs/sdks/revolut-id-sdk/web/api-reference/revolut-id","use":"$2"},{"id":"/docs/sdks/revolut-id-sdk/web/api-reference/revolutid-loader","title":"RevolutIdLoader","to":"/docs/sdks/revolut-id-sdk/web/api-reference/revolutid-loader","use":"$2"},{"id":"/docs/sdks/revolut-id-sdk/web/api-reference/button-client","title":"ButtonClient","to":"/docs/sdks/revolut-id-sdk/web/api-reference/button-client","use":"$2"},{"id":"/docs/sdks/revolut-id-sdk/web/api-reference/button-style","title":"ButtonStyle","to":"/docs/sdks/revolut-id-sdk/web/api-reference/button-style","use":"$2"},{"id":"/docs/sdks/revolut-id-sdk/web/api-reference/openid-configuration","title":"OIDC Configuration","to":"/docs/sdks/revolut-id-sdk/web/api-reference/openid-configuration","use":"$2"}]}]},{"id":"/docs/sdks/revolut-id-sdk/ios","title":"iOS","use":"$2","items":[{"id":"/docs/sdks/revolut-id-sdk/ios/introduction","title":"Introduction","to":"/docs/sdks/revolut-id-sdk/ios/introduction","use":"$2"},{"id":"/docs/sdks/revolut-id-sdk/ios/integration-guide","title":"Integration guide","to":"/docs/sdks/revolut-id-sdk/ios/integration-guide","use":"$2"},{"id":"/docs/sdks/revolut-id-sdk/ios/code-exchange","title":"Code exchange","to":"/docs/sdks/revolut-id-sdk/ios/code-exchange","use":"$2"},{"id":"/docs/sdks/revolut-id-sdk/ios/api-reference","title":"Methods and parameters","use":"$2","to":"/docs/sdks/revolut-id-sdk/ios/api-reference","items":[]}]},{"id":"/docs/sdks/revolut-id-sdk/android","title":"Android","use":"$2","items":[{"id":"/docs/sdks/revolut-id-sdk/android/introduction","title":"Introduction","to":"/docs/sdks/revolut-id-sdk/android/introduction","use":"$2"},{"id":"/docs/sdks/revolut-id-sdk/android/integration-guide","title":"Integration guide","to":"/docs/sdks/revolut-id-sdk/android/integration-guide","use":"$2"},{"id":"/docs/sdks/revolut-id-sdk/android/code-exchange","title":"Code exchange","to":"/docs/sdks/revolut-id-sdk/android/code-exchange","use":"$2"},{"id":"/docs/sdks/revolut-id-sdk/android/methods-parameters","title":"Methods and parameters","to":"/docs/sdks/revolut-id-sdk/android/methods-parameters","use":"$2"}]}]},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk","title":"UI Kit MiniApp Web SDK","use":"$2","root":true,"items":[{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/introduction","title":"Introduction","to":"/docs/sdks/ui-kit-miniapp-web-sdk/introduction","use":"$2"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components","title":"Components","use":"$2","items":[{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Action","title":"Action","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Action","use":"$2"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/ActionButton","title":"ActionButton","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/ActionButton","use":"$2"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Avatar","title":"Avatar","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Avatar","use":"$2"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Badge","title":"Badge","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Badge","use":"$2"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/BottomSheet","title":"BottomSheet","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/BottomSheet","use":"$2"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Button","title":"Button","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Button","use":"$2"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Calendar","title":"Calendar","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Calendar","use":"$2"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Cell","title":"Cell","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Cell","use":"$2"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/CellSkeleton","title":"CellSkeleton","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/CellSkeleton","use":"$2"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Checkbox","title":"Checkbox","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Checkbox","use":"$2"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/CompactInput","title":"CompactInput","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/CompactInput","use":"$2"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Copyable","title":"Copyable","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Copyable","use":"$2"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/DetailsCell","title":"DetailsCell","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/DetailsCell","use":"$2"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Dropdown","title":"Dropdown","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Dropdown","use":"$2"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/FilterButton","title":"FilterButton","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/FilterButton","use":"$2"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Footnote","title":"Footnote","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Footnote","use":"$2"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Group","title":"Group","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Group","use":"$2"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/HStack","title":"HStack","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/HStack","use":"$2"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Icon","title":"Icon","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Icon","use":"$2"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Image","title":"Image","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Image","use":"$2"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Input","title":"Input","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Input","use":"$2"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Link","title":"Link","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Link","use":"$2"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/List","title":"List","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/List","use":"$2"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Map","title":"Map","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Map","use":"$2"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/MessageBubble","title":"MessageBubble","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/MessageBubble","use":"$2"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Page","title":"Page","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Page","use":"$2"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Placeholder","title":"Placeholder","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Placeholder","use":"$2"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Popup","title":"Popup","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Popup","use":"$2"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/ProgressSteps","title":"ProgressSteps","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/ProgressSteps","use":"$2"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Radio","title":"Radio","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Radio","use":"$2"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/RootProvider","title":"RootProvider","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/RootProvider","use":"$2"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Search","title":"Search","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Search","use":"$2"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Slider","title":"Slider","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Slider","use":"$2"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Spacer","title":"Spacer","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Spacer","use":"$2"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/StarRating","title":"StarRating","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/StarRating","use":"$2"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Subheader","title":"Subheader","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Subheader","use":"$2"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Switch","title":"Switch","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Switch","use":"$2"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/TabBar","title":"TabBar","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/TabBar","use":"$2"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Text","title":"Text","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Text","use":"$2"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/TextArea","title":"TextArea","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/TextArea","use":"$2"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/ToggleButton","title":"ToggleButton","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/ToggleButton","use":"$2"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Toast","title":"Toast","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Toast","use":"$2"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/VStack","title":"VStack","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/VStack","use":"$2"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/VisuallyHidden","title":"VisuallyHidden","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/VisuallyHidden","use":"$2"}]},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/hooks","title":"Hooks","use":"$2","items":[{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/hooks/useStatusSheet","title":"useStatusSheet","to":"/docs/sdks/ui-kit-miniapp-web-sdk/hooks/useStatusSheet","use":"$2"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/hooks/useToast","title":"useToast","to":"/docs/sdks/ui-kit-miniapp-web-sdk/hooks/useToast","use":"$2"}]},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/constants","title":"Constants","use":"$2","items":[{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/constants/token","title":"Token","to":"/docs/sdks/ui-kit-miniapp-web-sdk/constants/token","use":"$2"}]},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/types","title":"Types","use":"$2","to":"/docs/sdks/ui-kit-miniapp-web-sdk/types","items":[{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/types/HTMLTag","title":"HTMLTag","to":"/docs/sdks/ui-kit-miniapp-web-sdk/types/HTMLTag","use":"$2"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/types/IconName","title":"IconName","to":"/docs/sdks/ui-kit-miniapp-web-sdk/types/IconName","use":"$2"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/types/NativeButtonProps","title":"NativeButtonProps","to":"/docs/sdks/ui-kit-miniapp-web-sdk/types/NativeButtonProps","use":"$2"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/types/NativeDivProps","title":"NativeDivProps","to":"/docs/sdks/ui-kit-miniapp-web-sdk/types/NativeDivProps","use":"$2"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/types/NativeHeadingProps","title":"NativeHeadingProps","to":"/docs/sdks/ui-kit-miniapp-web-sdk/types/NativeHeadingProps","use":"$2"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/types/NativeMainProps","title":"NativeMainProps","to":"/docs/sdks/ui-kit-miniapp-web-sdk/types/NativeMainProps","use":"$2"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/types/NativeSpanProps","title":"NativeSpanProps","to":"/docs/sdks/ui-kit-miniapp-web-sdk/types/NativeSpanProps","use":"$2"}]}]}],"blog":[{"id":"/blog","title":"All posts","use":"$2","to":"/blog"},{"id":"separator-recent","title":"Recent","use":"$3"},{"id":"/blog/2026-07-14-tap-to-pay-sdk","title":"New: Tap to Pay SDK for iOS","use":"$2","to":"/blog/2026-07-14-tap-to-pay-sdk"},{"id":"/blog/2026-07-06-revolut-checkout-hide-customer-details","title":"Revolut Checkout: hide customer details with pr…","use":"$2","to":"/blog/2026-07-06-revolut-checkout-hide-customer-details"},{"id":"/blog/2026-06-02-react-native-merchant-sdks","title":"New: Revolut Pay and Card Form SDKs for React N…","use":"$2","to":"/blog/2026-06-02-react-native-merchant-sdks"},{"id":"/blog/2026-05-28-incremental-authorisation-sandbox","title":"Incremental Authorisation: Sandbox testing now …","use":"$2","to":"/blog/2026-05-28-incremental-authorisation-sandbox"},{"id":"/blog/2026-05-06-revolut-checkout-sdk-reference","title":"Revolut Checkout: full SDK reference and shippi…","use":"$2","to":"/blog/2026-05-06-revolut-checkout-sdk-reference"}],"openapiByPath":{"/docs/api/business":{"items":[{"id":"/docs/api/business#tag-accounting","title":"Accounting","use":"a","href":"#tag-accounting","items":[{"id":"/docs/api/business#create-accounting-category","title":"Create an accounting category","use":"a","href":"#create-accounting-category","options":{"method":"post"}},{"id":"/docs/api/business#get-accounting-categories","title":"Retrieve a list of accounting categories","use":"a","href":"#get-accounting-categories","options":{"method":"get"}},{"id":"/docs/api/business#get-accounting-category","title":"Retrieve accounting category details","use":"a","href":"#get-accounting-category","options":{"method":"get"}},{"id":"/docs/api/business#update-accounting-category","title":"Update accounting category settings","use":"a","href":"#update-accounting-category","options":{"method":"patch"}},{"id":"/docs/api/business#delete-accounting-category","title":"Delete an accounting category","use":"a","href":"#delete-accounting-category","options":{"method":"delete"}},{"id":"/docs/api/business#create-label-group","title":"Create a new label group","use":"a","href":"#create-label-group","options":{"method":"post"}},{"id":"/docs/api/business#get-label-groups","title":"Retrieve a list of label groups","use":"a","href":"#get-label-groups","options":{"method":"get"}},{"id":"/docs/api/business#get-label-group","title":"Retrieve label group details","use":"a","href":"#get-label-group","options":{"method":"get"}},{"id":"/docs/api/business#update-label-group","title":"Update label group settings","use":"a","href":"#update-label-group","options":{"method":"patch"}},{"id":"/docs/api/business#delete-label-group","title":"Delete a label group","use":"a","href":"#delete-label-group","options":{"method":"delete"}},{"id":"/docs/api/business#create-label","title":"Create a new label","use":"a","href":"#create-label","options":{"method":"post"}},{"id":"/docs/api/business#get-labels","title":"Retrieve a list of labels from a label group","use":"a","href":"#get-labels","options":{"method":"get"}},{"id":"/docs/api/business#update-label","title":"Update a label","use":"a","href":"#update-label","options":{"method":"patch"}},{"id":"/docs/api/business#delete-label","title":"Delete a label","use":"a","href":"#delete-label","options":{"method":"delete"}},{"id":"/docs/api/business#create-tax-rate","title":"Create a new tax rate","use":"a","href":"#create-tax-rate","options":{"method":"post"}},{"id":"/docs/api/business#get-tax-rates","title":"Retrieve a list of tax rates","use":"a","href":"#get-tax-rates","options":{"method":"get"}},{"id":"/docs/api/business#get-tax-rate","title":"Retrieve tax rate details","use":"a","href":"#get-tax-rate","options":{"method":"get"}},{"id":"/docs/api/business#update-tax-rate","title":"Update tax rate settings","use":"a","href":"#update-tax-rate","options":{"method":"patch"}},{"id":"/docs/api/business#delete-tax-rate","title":"Delete a tax rate","use":"a","href":"#delete-tax-rate","options":{"method":"delete"}}]},{"id":"/docs/api/business#tag-accounts","title":"Accounts","use":"a","href":"#tag-accounts","items":[{"id":"/docs/api/business#get-accounts","title":"Retrieve all accounts","use":"a","href":"#get-accounts","options":{"method":"get"}},{"id":"/docs/api/business#get-account","title":"Retrieve an account","use":"a","href":"#get-account","options":{"method":"get"}},{"id":"/docs/api/business#get-account-details","title":"Retrieve account's full bank details","use":"a","href":"#get-account-details","options":{"method":"get"}}]},{"id":"/docs/api/business#tag-cards","title":"Cards","use":"a","href":"#tag-cards","items":[{"id":"/docs/api/business#get-cards","title":"Retrieve a list of cards","use":"a","href":"#get-cards","options":{"method":"get"}},{"id":"/docs/api/business#create-card","title":"Create a card","use":"a","href":"#create-card","options":{"method":"post"}},{"id":"/docs/api/business#get-card","title":"Retrieve card details","use":"a","href":"#get-card","options":{"method":"get"}},{"id":"/docs/api/business#update-card","title":"Update card settings","use":"a","href":"#update-card","options":{"method":"patch"}},{"id":"/docs/api/business#delete-card","title":"Terminate a card","use":"a","href":"#delete-card","options":{"method":"delete"}},{"id":"/docs/api/business#update-card-contacts","title":"Update card contacts","use":"a","href":"#update-card-contacts","options":{"method":"put"}},{"id":"/docs/api/business#update-card-references","title":"Update card references","use":"a","href":"#update-card-references","options":{"method":"put"}},{"id":"/docs/api/business#freeze-card","title":"Freeze a card","use":"a","href":"#freeze-card","options":{"method":"post"}},{"id":"/docs/api/business#unfreeze-card","title":"Unfreeze a card","use":"a","href":"#unfreeze-card","options":{"method":"post"}},{"id":"/docs/api/business#lock-card","title":"Lock a card","use":"a","href":"#lock-card","options":{"method":"post"}},{"id":"/docs/api/business#unlock-card","title":"Unlock a card","use":"a","href":"#unlock-card","options":{"method":"post"}},{"id":"/docs/api/business#get-sensitive-card-details","title":"Retrieve sensitive card details","use":"a","href":"#get-sensitive-card-details","options":{"method":"get"}}]},{"id":"/docs/api/business#tag-card-invitations","title":"Card invitations","use":"a","href":"#tag-card-invitations","items":[{"id":"/docs/api/business#create-card-invitation","title":"Create a card invitation","use":"a","href":"#create-card-invitation","options":{"method":"post"}},{"id":"/docs/api/business#get-card-invitations","title":"Retrieve a list of card invitations","use":"a","href":"#get-card-invitations","options":{"method":"get"}},{"id":"/docs/api/business#get-card-invitation","title":"Retrieve card invitation details","use":"a","href":"#get-card-invitation","options":{"method":"get"}},{"id":"/docs/api/business#update-card-invitation","title":"Update card invitation settings","use":"a","href":"#update-card-invitation","options":{"method":"patch"}},{"id":"/docs/api/business#cancel-card-invitation","title":"Cancel a card invitation","use":"a","href":"#cancel-card-invitation","options":{"method":"post"}}]},{"id":"/docs/api/business#tag-counterparties","title":"Counterparties","use":"a","href":"#tag-counterparties","items":[{"id":"/docs/api/business#validate-account-name","title":"Validate an account name (CoP/VoP)","use":"a","href":"#validate-account-name","options":{"method":"post"}},{"id":"/docs/api/business#get-counterparties","title":"Retrieve a list of counterparties","use":"a","href":"#get-counterparties","options":{"method":"get"}},{"id":"/docs/api/business#add-counterparty","title":"Create a counterparty","use":"a","href":"#add-counterparty","options":{"method":"post"}},{"id":"/docs/api/business#get-counterparty-countries","title":"Check supported countries and currencies","use":"a","href":"#get-counterparty-countries","options":{"method":"get"}},{"id":"/docs/api/business#get-counterparty-requirements","title":"Check counterparty field requirements","use":"a","href":"#get-counterparty-requirements","options":{"method":"get"}},{"id":"/docs/api/business#get-counterparty","title":"Retrieve a counterparty","use":"a","href":"#get-counterparty","options":{"method":"get"}},{"id":"/docs/api/business#delete-counterparty","title":"Delete a counterparty","use":"a","href":"#delete-counterparty","options":{"method":"delete"}},{"id":"/docs/api/business#update-counterparty-payment-method","title":"Update a counterparty's payment method","use":"a","href":"#update-counterparty-payment-method","options":{"method":"patch"}}]},{"id":"/docs/api/business#tag-expenses","title":"Expenses","use":"a","href":"#tag-expenses","items":[{"id":"/docs/api/business#get-expenses","title":"Retrieve a list of expenses","use":"a","href":"#get-expenses","options":{"method":"get"}},{"id":"/docs/api/business#get-expense","title":"Retrieve an expense","use":"a","href":"#get-expense","options":{"method":"get"}},{"id":"/docs/api/business#get-expense-receipt","title":"Retrieve a receipt related to an expense","use":"a","href":"#get-expense-receipt","options":{"method":"get"}}]},{"id":"/docs/api/business#tag-foreign-exchange","title":"Foreign exchange","use":"a","href":"#tag-foreign-exchange","items":[{"id":"/docs/api/business#get-rate","title":"Get an exchange rate","use":"a","href":"#get-rate","options":{"method":"get"}},{"id":"/docs/api/business#exchange-money","title":"Exchange money","use":"a","href":"#exchange-money","options":{"method":"post"}},{"id":"/docs/api/business#get-exchange-reasons","title":"Get exchange reasons","use":"a","href":"#get-exchange-reasons","options":{"method":"get"}}]},{"id":"/docs/api/business#tag-payment-drafts","title":"Payment drafts","use":"a","href":"#tag-payment-drafts","items":[{"id":"/docs/api/business#get-payment-drafts","title":"Retrieve a list of payment drafts","use":"a","href":"#get-payment-drafts","options":{"method":"get"}},{"id":"/docs/api/business#create-payment-draft","title":"Create a payment draft","use":"a","href":"#create-payment-draft","options":{"method":"post"}},{"id":"/docs/api/business#get-payment-draft","title":"Retrieve a payment draft","use":"a","href":"#get-payment-draft","options":{"method":"get"}},{"id":"/docs/api/business#delete-payment-draft","title":"Delete a payment draft","use":"a","href":"#delete-payment-draft","options":{"method":"delete"}},{"id":"/docs/api/business#update-payment-draft","title":"Update a payment draft","use":"a","href":"#update-payment-draft","options":{"method":"patch"}},{"id":"/docs/api/business#add-payment-draft-payment","title":"Add a payment to a payment draft","use":"a","href":"#add-payment-draft-payment","options":{"method":"post"}},{"id":"/docs/api/business#update-payment-draft-payment","title":"Update a payment in a payment draft","use":"a","href":"#update-payment-draft-payment","options":{"method":"patch"}},{"id":"/docs/api/business#delete-payment-draft-payment","title":"Delete a payment from a payment draft","use":"a","href":"#delete-payment-draft-payment","options":{"method":"delete"}}]},{"id":"/docs/api/business#tag-payout-links","title":"Payout links","use":"a","href":"#tag-payout-links","items":[{"id":"/docs/api/business#create-payout-link","title":"Create a payout link","use":"a","href":"#create-payout-link","options":{"method":"post"}},{"id":"/docs/api/business#get-payout-links","title":"Retrieve a list of payout links","use":"a","href":"#get-payout-links","options":{"method":"get"}},{"id":"/docs/api/business#get-payout-link","title":"Retrieve a payout link","use":"a","href":"#get-payout-link","options":{"method":"get"}},{"id":"/docs/api/business#cancel-payout-link","title":"Cancel a payout link","use":"a","href":"#cancel-payout-link","options":{"method":"post"}}]},{"id":"/docs/api/business#tag-simulations","title":"Simulations","use":"a","href":"#tag-simulations","items":[{"id":"/docs/api/business#simulate-transfer-state-update","title":"Simulate a transfer state update (Sandbox only)","use":"a","href":"#simulate-transfer-state-update","options":{"method":"post"}},{"id":"/docs/api/business#simulate-top-up","title":"Simulate an account top-up (Sandbox only)","use":"a","href":"#simulate-top-up","options":{"method":"post"}}]},{"id":"/docs/api/business#tag-teams","title":"Teams","use":"a","href":"#tag-teams","items":[{"id":"/docs/api/business#get-team-members","title":"Retrieve a list of team members","use":"a","href":"#get-team-members","options":{"method":"get"}},{"id":"/docs/api/business#invite-team-member","title":"Invite a new member to your business","use":"a","href":"#invite-team-member","options":{"method":"post"}},{"id":"/docs/api/business#get-team-member-by-id","title":"Retrieve a team member","use":"a","href":"#get-team-member-by-id","options":{"method":"get"}},{"id":"/docs/api/business#delete-team-member","title":"Delete a team member","use":"a","href":"#delete-team-member","options":{"method":"delete"}},{"id":"/docs/api/business#assign-department","title":"Assign a department to a team member","use":"a","href":"#assign-department","options":{"method":"put"}},{"id":"/docs/api/business#unassign-department","title":"Remove department from a team member","use":"a","href":"#unassign-department","options":{"method":"delete"}},{"id":"/docs/api/business#assign-manager","title":"Assign a manager to a team member","use":"a","href":"#assign-manager","options":{"method":"put"}},{"id":"/docs/api/business#unassign-manager","title":"Remove manager from a team member","use":"a","href":"#unassign-manager","options":{"method":"delete"}},{"id":"/docs/api/business#update-team-member-role","title":"Update a team member's role","use":"a","href":"#update-team-member-role","options":{"method":"put"}},{"id":"/docs/api/business#suspend-team-member","title":"Suspend a team member","use":"a","href":"#suspend-team-member","options":{"method":"post"}},{"id":"/docs/api/business#unsuspend-team-member","title":"Unsuspend a team member","use":"a","href":"#unsuspend-team-member","options":{"method":"post"}},{"id":"/docs/api/business#get-roles","title":"Retrieve team roles","use":"a","href":"#get-roles","options":{"method":"get"}},{"id":"/docs/api/business#create-department","title":"Create a department","use":"a","href":"#create-department","options":{"method":"post"}},{"id":"/docs/api/business#get-departments","title":"Retrieve a list of departments","use":"a","href":"#get-departments","options":{"method":"get"}},{"id":"/docs/api/business#get-department","title":"Retrieve a department","use":"a","href":"#get-department","options":{"method":"get"}},{"id":"/docs/api/business#update-department","title":"Update a department","use":"a","href":"#update-department","options":{"method":"patch"}},{"id":"/docs/api/business#delete-department","title":"Delete a department","use":"a","href":"#delete-department","options":{"method":"delete"}}]},{"id":"/docs/api/business#tag-transactions","title":"Transactions","use":"a","href":"#tag-transactions","items":[{"id":"/docs/api/business#get-transactions","title":"Retrieve a list of transactions","use":"a","href":"#get-transactions","options":{"method":"get"}},{"id":"/docs/api/business#get-transaction","title":"Retrieve a transaction","use":"a","href":"#get-transaction","options":{"method":"get"}}]},{"id":"/docs/api/business#tag-transfers","title":"Transfers","use":"a","href":"#tag-transfers","items":[{"id":"/docs/api/business#create-payment","title":"Create a transfer to another account or card","use":"a","href":"#create-payment","options":{"method":"post"}},{"id":"/docs/api/business#get-indicative-quote","title":"Get an indicative quote for a transfer","use":"a","href":"#get-indicative-quote","options":{"method":"post"}},{"id":"/docs/api/business#get-payment-requirements","title":"Check transfer field requirements","use":"a","href":"#get-payment-requirements","options":{"method":"post"}},{"id":"/docs/api/business#create-transfer","title":"Move money between your accounts","use":"a","href":"#create-transfer","options":{"method":"post"}},{"id":"/docs/api/business#get-transfer-reasons","title":"Get transfer reasons","use":"a","href":"#get-transfer-reasons","options":{"method":"get"}}]},{"id":"/docs/api/business#tag-webhooks-v1-deprecated","title":"Webhooks (v1) (deprecated)","use":"a","href":"#tag-webhooks-v1-deprecated","items":[{"id":"/docs/api/business#get-webhook-v1","title":"Retrieve a webhook","use":"a","href":"#get-webhook-v1","options":{"method":"get"}},{"id":"/docs/api/business#set-up-webhook","title":"Set a webhook","use":"a","href":"#set-up-webhook","options":{"method":"post"}},{"id":"/docs/api/business#delete-webhook-v1","title":"Delete a webhook","use":"a","href":"#delete-webhook-v1","options":{"method":"delete"}}]},{"id":"/docs/api/business#tag-webhooks-v2","title":"Webhooks (v2)","use":"a","href":"#tag-webhooks-v2","items":[{"id":"/docs/api/business#create-webhook","title":"Create a new webhook","use":"a","href":"#create-webhook","options":{"method":"post"}},{"id":"/docs/api/business#get-webhooks","title":"Retrieve a list of webhooks","use":"a","href":"#get-webhooks","options":{"method":"get"}},{"id":"/docs/api/business#get-webhook","title":"Retrieve a webhook","use":"a","href":"#get-webhook","options":{"method":"get"}},{"id":"/docs/api/business#update-webhook","title":"Update a webhook","use":"a","href":"#update-webhook","options":{"method":"patch"}},{"id":"/docs/api/business#delete-webhook","title":"Delete a webhook","use":"a","href":"#delete-webhook","options":{"method":"delete"}},{"id":"/docs/api/business#rotate-webhook-signing-secret","title":"Rotate a webhook signing secret","use":"a","href":"#rotate-webhook-signing-secret","options":{"method":"post"}},{"id":"/docs/api/business#get-failed-webhook-events","title":"Retrieve a list of failed webhook events","use":"a","href":"#get-failed-webhook-events","options":{"method":"get"}}]}],"versions":"$undefined"},"/docs/api/crypto-ramp/2.0.0":{"items":[{"id":"/docs/api/crypto-ramp/2.0.0#tag-partners","title":"Partners","use":"a","href":"#tag-partners","items":[{"id":"/docs/api/crypto-ramp/2.0.0#retrieve-configuration","title":"Retrieve buy configuration","use":"a","href":"#retrieve-configuration","options":{"method":"get"}},{"id":"/docs/api/crypto-ramp/2.0.0#retrieve-an-order-quote","title":"Retrieve a buy order quote","use":"a","href":"#retrieve-an-order-quote","options":{"method":"get"}},{"id":"/docs/api/crypto-ramp/2.0.0#retrieve-a-redirect-url","title":"Retrieve a buy redirect URL","use":"a","href":"#retrieve-a-redirect-url","options":{"method":"get"}},{"id":"/docs/api/crypto-ramp/2.0.0#retrieve-an-order","title":"Retrieve a buy order","use":"a","href":"#retrieve-an-order","options":{"method":"get"}},{"id":"/docs/api/crypto-ramp/2.0.0#retrieve-all-orders","title":"Retrieve all buy orders","use":"a","href":"#retrieve-all-orders","options":{"method":"get"}},{"id":"/docs/api/crypto-ramp/2.0.0#retrieve-sell-configuration","title":"Retrieve sell configuration","use":"a","href":"#retrieve-sell-configuration","options":{"method":"get"}},{"id":"/docs/api/crypto-ramp/2.0.0#retrieve-a-sell-order-quote","title":"Retrieve a sell order quote","use":"a","href":"#retrieve-a-sell-order-quote","options":{"method":"get"}},{"id":"/docs/api/crypto-ramp/2.0.0#retrieve-a-sell-redirect-url","title":"Retrieve a sell redirect URL","use":"a","href":"#retrieve-a-sell-redirect-url","options":{"method":"get"}},{"id":"/docs/api/crypto-ramp/2.0.0#retrieve-a-sell-order","title":"Retrieve a sell order","use":"a","href":"#retrieve-a-sell-order","options":{"method":"get"}},{"id":"/docs/api/crypto-ramp/2.0.0#retrieve-all-sell-orders","title":"Retrieve all sell orders","use":"a","href":"#retrieve-all-sell-orders","options":{"method":"get"}}]},{"id":"/docs/api/crypto-ramp/2.0.0#tag-webhooks","title":"Webhooks","use":"a","href":"#tag-webhooks","items":[{"id":"/docs/api/crypto-ramp/2.0.0#retrieve-a-webhook","title":"Retrieve a webhook","use":"a","href":"#retrieve-a-webhook","options":{"method":"get"}},{"id":"/docs/api/crypto-ramp/2.0.0#update-a-webhook","title":"Update a webhook","use":"a","href":"#update-a-webhook","options":{"method":"patch"}},{"id":"/docs/api/crypto-ramp/2.0.0#delete-a-webhook","title":"Delete a webhook","use":"a","href":"#delete-a-webhook","options":{"method":"delete"}},{"id":"/docs/api/crypto-ramp/2.0.0#retrieve-a-list-of-webhooks","title":"Retrieve a list of webhooks","use":"a","href":"#retrieve-a-list-of-webhooks","options":{"method":"get"}},{"id":"/docs/api/crypto-ramp/2.0.0#create-a-webhook","title":"Create a webhook","use":"a","href":"#create-a-webhook","options":{"method":"post"}}]}],"versions":[{"label":"2.0.0","path":"/docs/api/crypto-ramp","latest":true},{"label":"1.0.0","path":"/docs/api/crypto-ramp/1.0.0","latest":false}]},"/docs/api/crypto-ramp/1.0.0":{"items":[{"id":"/docs/api/crypto-ramp/1.0.0#tag-partners","title":"Partners","use":"a","href":"#tag-partners","items":[{"id":"/docs/api/crypto-ramp/1.0.0#retrieve-configuration","title":"Retrieve configuration","use":"a","href":"#retrieve-configuration","options":{"method":"get"}},{"id":"/docs/api/crypto-ramp/1.0.0#retrieve-an-order-quote","title":"Retrieve an order quote","use":"a","href":"#retrieve-an-order-quote","options":{"method":"get"}},{"id":"/docs/api/crypto-ramp/1.0.0#retrieve-a-redirect-url","title":"Retrieve a redirect URL","use":"a","href":"#retrieve-a-redirect-url","options":{"method":"get"}},{"id":"/docs/api/crypto-ramp/1.0.0#retrieve-an-order","title":"Retrieve an order","use":"a","href":"#retrieve-an-order","options":{"method":"get"}},{"id":"/docs/api/crypto-ramp/1.0.0#retrieve-all-orders","title":"Retrieve all orders","use":"a","href":"#retrieve-all-orders","options":{"method":"get"}}]},{"id":"/docs/api/crypto-ramp/1.0.0#tag-webhooks","title":"Webhooks","use":"a","href":"#tag-webhooks","items":[{"id":"/docs/api/crypto-ramp/1.0.0#retrieve-a-webhook","title":"Retrieve a webhook","use":"a","href":"#retrieve-a-webhook","options":{"method":"get"}},{"id":"/docs/api/crypto-ramp/1.0.0#update-a-webhook","title":"Update a webhook","use":"a","href":"#update-a-webhook","options":{"method":"patch"}},{"id":"/docs/api/crypto-ramp/1.0.0#delete-a-webhook","title":"Delete a webhook","use":"a","href":"#delete-a-webhook","options":{"method":"delete"}},{"id":"/docs/api/crypto-ramp/1.0.0#retrieve-a-list-of-webhooks","title":"Retrieve a list of webhooks","use":"a","href":"#retrieve-a-list-of-webhooks","options":{"method":"get"}},{"id":"/docs/api/crypto-ramp/1.0.0#create-a-webhook","title":"Create a webhook","use":"a","href":"#create-a-webhook","options":{"method":"post"}}]}],"versions":[{"label":"2.0.0","path":"/docs/api/crypto-ramp","latest":true},{"label":"1.0.0","path":"/docs/api/crypto-ramp/1.0.0","latest":false}]},"/docs/api/crypto-ramp":{"items":[{"id":"/docs/api/crypto-ramp#tag-partners","title":"Partners","use":"a","href":"#tag-partners","items":[{"id":"/docs/api/crypto-ramp#retrieve-configuration","title":"Retrieve buy configuration","use":"a","href":"#retrieve-configuration","options":{"method":"get"}},{"id":"/docs/api/crypto-ramp#retrieve-an-order-quote","title":"Retrieve a buy order quote","use":"a","href":"#retrieve-an-order-quote","options":{"method":"get"}},{"id":"/docs/api/crypto-ramp#retrieve-a-redirect-url","title":"Retrieve a buy redirect URL","use":"a","href":"#retrieve-a-redirect-url","options":{"method":"get"}},{"id":"/docs/api/crypto-ramp#retrieve-an-order","title":"Retrieve a buy order","use":"a","href":"#retrieve-an-order","options":{"method":"get"}},{"id":"/docs/api/crypto-ramp#retrieve-all-orders","title":"Retrieve all buy orders","use":"a","href":"#retrieve-all-orders","options":{"method":"get"}},{"id":"/docs/api/crypto-ramp#retrieve-sell-configuration","title":"Retrieve sell configuration","use":"a","href":"#retrieve-sell-configuration","options":{"method":"get"}},{"id":"/docs/api/crypto-ramp#retrieve-a-sell-order-quote","title":"Retrieve a sell order quote","use":"a","href":"#retrieve-a-sell-order-quote","options":{"method":"get"}},{"id":"/docs/api/crypto-ramp#retrieve-a-sell-redirect-url","title":"Retrieve a sell redirect URL","use":"a","href":"#retrieve-a-sell-redirect-url","options":{"method":"get"}},{"id":"/docs/api/crypto-ramp#retrieve-a-sell-order","title":"Retrieve a sell order","use":"a","href":"#retrieve-a-sell-order","options":{"method":"get"}},{"id":"/docs/api/crypto-ramp#retrieve-all-sell-orders","title":"Retrieve all sell orders","use":"a","href":"#retrieve-all-sell-orders","options":{"method":"get"}}]},{"id":"/docs/api/crypto-ramp#tag-webhooks","title":"Webhooks","use":"a","href":"#tag-webhooks","items":[{"id":"/docs/api/crypto-ramp#retrieve-a-webhook","title":"Retrieve a webhook","use":"a","href":"#retrieve-a-webhook","options":{"method":"get"}},{"id":"/docs/api/crypto-ramp#update-a-webhook","title":"Update a webhook","use":"a","href":"#update-a-webhook","options":{"method":"patch"}},{"id":"/docs/api/crypto-ramp#delete-a-webhook","title":"Delete a webhook","use":"a","href":"#delete-a-webhook","options":{"method":"delete"}},{"id":"/docs/api/crypto-ramp#retrieve-a-list-of-webhooks","title":"Retrieve a list of webhooks","use":"a","href":"#retrieve-a-list-of-webhooks","options":{"method":"get"}},{"id":"/docs/api/crypto-ramp#create-a-webhook","title":"Create a webhook","use":"a","href":"#create-a-webhook","options":{"method":"post"}}]}],"versions":[{"label":"2.0.0","path":"/docs/api/crypto-ramp","latest":true},{"label":"1.0.0","path":"/docs/api/crypto-ramp/1.0.0","latest":false}]},"/docs/api/merchant/2026-08-17":{"items":[{"id":"/docs/api/merchant/2026-08-17#tag-orders","title":"Orders","use":"a","href":"#tag-orders","items":[{"id":"/docs/api/merchant/2026-08-17#create-order","title":"Create an order","use":"a","href":"#create-order","options":{"method":"post"}},{"id":"/docs/api/merchant/2026-08-17#retrieve-order-list","title":"Retrieve an order list","use":"a","href":"#retrieve-order-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-08-17#retrieve-order","title":"Retrieve an order","use":"a","href":"#retrieve-order","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-08-17#update-order","title":"Update an order","use":"a","href":"#update-order","options":{"method":"patch"}},{"id":"/docs/api/merchant/2026-08-17#increment-authorisation","title":"Increment authorisation","use":"a","href":"#increment-authorisation","options":{"method":"post"}},{"id":"/docs/api/merchant/2026-08-17#capture-order","title":"Capture an order","use":"a","href":"#capture-order","options":{"method":"post"}},{"id":"/docs/api/merchant/2026-08-17#cancel-order","title":"Cancel an order","use":"a","href":"#cancel-order","options":{"method":"post"}},{"id":"/docs/api/merchant/2026-08-17#refund-order","title":"Refund an order","use":"a","href":"#refund-order","options":{"method":"post"}},{"id":"/docs/api/merchant/2026-08-17#pay-order","title":"Pay for an order","use":"a","href":"#pay-order","options":{"method":"post"}},{"id":"/docs/api/merchant/2026-08-17#retrieve-payment-list","title":"Retrieve payment list of an order","use":"a","href":"#retrieve-payment-list","options":{"method":"get"}}]},{"id":"/docs/api/merchant/2026-08-17#tag-customers","title":"Customers","use":"a","href":"#tag-customers","items":[{"id":"/docs/api/merchant/2026-08-17#create-customer","title":"Create a customer","use":"a","href":"#create-customer","options":{"method":"post"}},{"id":"/docs/api/merchant/2026-08-17#retrieve-customer-list","title":"Retrieve a customer list","use":"a","href":"#retrieve-customer-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-08-17#retrieve-customer","title":"Retrieve a customer","use":"a","href":"#retrieve-customer","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-08-17#update-customer","title":"Update a customer","use":"a","href":"#update-customer","options":{"method":"patch"}},{"id":"/docs/api/merchant/2026-08-17#delete-customer","title":"Delete a customer","use":"a","href":"#delete-customer","options":{"method":"delete"}},{"id":"/docs/api/merchant/2026-08-17#retrieve-payment-method-list","title":"Retrieve payment method list of a customer","use":"a","href":"#retrieve-payment-method-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-08-17#retrieve-payment-method","title":"Retrieve a customer's payment method","use":"a","href":"#retrieve-payment-method","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-08-17#update-payment-method","title":"Update a customer's payment method","use":"a","href":"#update-payment-method","options":{"method":"patch"}},{"id":"/docs/api/merchant/2026-08-17#delete-payment-method","title":"Delete a customer's payment method","use":"a","href":"#delete-payment-method","options":{"method":"delete"}}]},{"id":"/docs/api/merchant/2026-08-17#tag-payments","title":"Payments","use":"a","href":"#tag-payments","items":[{"id":"/docs/api/merchant/2026-08-17#retrieve-payment-details","title":"Retrieve payment details","use":"a","href":"#retrieve-payment-details","options":{"method":"get"}}]},{"id":"/docs/api/merchant/2026-08-17#tag-subscriptions","title":"Subscriptions","use":"a","href":"#tag-subscriptions","items":[{"id":"/docs/api/merchant/2026-08-17#create-subscription-plan","title":"Create a subscription plan","use":"a","href":"#create-subscription-plan","options":{"method":"post"}},{"id":"/docs/api/merchant/2026-08-17#retrieve-subscription-plan-list","title":"Retrieve a subscription plan list","use":"a","href":"#retrieve-subscription-plan-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-08-17#retrieve-subscription-plan","title":"Retrieve a subscription plan","use":"a","href":"#retrieve-subscription-plan","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-08-17#create-subscription","title":"Create a subscription","use":"a","href":"#create-subscription","options":{"method":"post"}},{"id":"/docs/api/merchant/2026-08-17#retrieve-subscription-list","title":"Retrieve a subscription list","use":"a","href":"#retrieve-subscription-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-08-17#retrieve-subscription","title":"Retrieve a subscription","use":"a","href":"#retrieve-subscription","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-08-17#update-subscription","title":"Update a subscription","use":"a","href":"#update-subscription","options":{"method":"patch"}},{"id":"/docs/api/merchant/2026-08-17#change-subscription-plan","title":"Change a subscription plan","use":"a","href":"#change-subscription-plan","options":{"method":"post"}},{"id":"/docs/api/merchant/2026-08-17#update-subscription-renewal-date","title":"Update a subscription renewal date","use":"a","href":"#update-subscription-renewal-date","options":{"method":"post"}},{"id":"/docs/api/merchant/2026-08-17#cancel-subscription","title":"Cancel a subscription","use":"a","href":"#cancel-subscription","options":{"method":"post"}},{"id":"/docs/api/merchant/2026-08-17#retrieve-subscription-cycle-list","title":"Retrieve a subscription cycle list","use":"a","href":"#retrieve-subscription-cycle-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-08-17#retrieve-subscription-cycle","title":"Retrieve a subscription cycle","use":"a","href":"#retrieve-subscription-cycle","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-08-17#create-subscription-usage","title":"Create a subscription usage","use":"a","href":"#create-subscription-usage","options":{"method":"post"}},{"id":"/docs/api/merchant/2026-08-17#retrieve-subscription-usage-list","title":"Retrieve a subscription usage list","use":"a","href":"#retrieve-subscription-usage-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-08-17#retrieve-subscription-usage","title":"Retrieve a subscription usage","use":"a","href":"#retrieve-subscription-usage","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-08-17#update-subscription-usage","title":"Update a subscription usage","use":"a","href":"#update-subscription-usage","options":{"method":"patch"}},{"id":"/docs/api/merchant/2026-08-17#delete-subscription-usage","title":"Delete a subscription usage","use":"a","href":"#delete-subscription-usage","options":{"method":"delete"}}]},{"id":"/docs/api/merchant/2026-08-17#tag-payouts","title":"Payouts","use":"a","href":"#tag-payouts","items":[{"id":"/docs/api/merchant/2026-08-17#create-payout","title":"Create a payout","use":"a","href":"#create-payout","options":{"method":"post"}},{"id":"/docs/api/merchant/2026-08-17#retrieve-payout-list","title":"Retrieve a payout list","use":"a","href":"#retrieve-payout-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-08-17#retrieve-payout","title":"Retrieve a payout","use":"a","href":"#retrieve-payout","options":{"method":"get"}}]},{"id":"/docs/api/merchant/2026-08-17#tag-disputes","title":"Disputes","use":"a","href":"#tag-disputes","items":[{"id":"/docs/api/merchant/2026-08-17#retrieve-dispute-list","title":"Retrieve a dispute list","use":"a","href":"#retrieve-dispute-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-08-17#retrieve-dispute","title":"Retrieve a dispute","use":"a","href":"#retrieve-dispute","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-08-17#accept-dispute","title":"Accept a dispute","use":"a","href":"#accept-dispute","options":{"method":"post"}},{"id":"/docs/api/merchant/2026-08-17#upload-dispute-evidence","title":"Upload evidence for a dispute","use":"a","href":"#upload-dispute-evidence","options":{"method":"post"}},{"id":"/docs/api/merchant/2026-08-17#challenge-dispute","title":"Challenge a dispute","use":"a","href":"#challenge-dispute","options":{"method":"post"}}]},{"id":"/docs/api/merchant/2026-08-17#tag-report-runs","title":"Report runs","use":"a","href":"#tag-report-runs","items":[{"id":"/docs/api/merchant/2026-08-17#create-report-run","title":"Create a report run","use":"a","href":"#create-report-run","options":{"method":"post"}},{"id":"/docs/api/merchant/2026-08-17#retrieve-report-run","title":"Retrieve a report run","use":"a","href":"#retrieve-report-run","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-08-17#download-report-file","title":"Download report file","use":"a","href":"#download-report-file","options":{"method":"get"}}]},{"id":"/docs/api/merchant/2026-08-17#tag-webhooks","title":"Webhooks","use":"a","href":"#tag-webhooks","items":[{"id":"/docs/api/merchant/2026-08-17#create-webhook","title":"Create a webhook","use":"a","href":"#create-webhook","options":{"method":"post"}},{"id":"/docs/api/merchant/2026-08-17#retrieve-webhook-list","title":"Retrieve a webhook list","use":"a","href":"#retrieve-webhook-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-08-17#retrieve-webhook","title":"Retrieve a webhook","use":"a","href":"#retrieve-webhook","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-08-17#update-webhook","title":"Update a webhook","use":"a","href":"#update-webhook","options":{"method":"patch"}},{"id":"/docs/api/merchant/2026-08-17#delete-webhook","title":"Delete a webhook","use":"a","href":"#delete-webhook","options":{"method":"delete"}},{"id":"/docs/api/merchant/2026-08-17#rotate-webhook-signing-secret","title":"Rotate a webhook signing secret","use":"a","href":"#rotate-webhook-signing-secret","options":{"method":"post"}},{"id":"/docs/api/merchant/2026-08-17#webhook-webhook-event","title":"Webhook event","use":"a","href":"#webhook-webhook-event","options":{"method":"webhook"}}]},{"id":"/docs/api/merchant/2026-08-17#tag-locations","title":"Locations","use":"a","href":"#tag-locations","items":[{"id":"/docs/api/merchant/2026-08-17#create-location","title":"Create a location","use":"a","href":"#create-location","options":{"method":"post"}},{"id":"/docs/api/merchant/2026-08-17#retrieve-location-list","title":"Retrieve location list","use":"a","href":"#retrieve-location-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-08-17#retrieve-location","title":"Retrieve a location","use":"a","href":"#retrieve-location","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-08-17#update-location","title":"Update a location","use":"a","href":"#update-location","options":{"method":"patch"}},{"id":"/docs/api/merchant/2026-08-17#delete-location","title":"Delete a location","use":"a","href":"#delete-location","options":{"method":"delete"}}]},{"id":"/docs/api/merchant/2026-08-17#tag-terminals","title":"Terminals","use":"a","href":"#tag-terminals","items":[{"id":"/docs/api/merchant/2026-08-17#retrieve-terminal-list","title":"Retrieve terminal list","use":"a","href":"#retrieve-terminal-list","options":{"method":"get"}}]},{"id":"/docs/api/merchant/2026-08-17#tag-payment-intents","title":"Payment intents","use":"a","href":"#tag-payment-intents","items":[{"id":"/docs/api/merchant/2026-08-17#create-payment-intent","title":"Create a payment intent","use":"a","href":"#create-payment-intent","options":{"method":"post"}},{"id":"/docs/api/merchant/2026-08-17#retrieve-payment-intent","title":"Retrieve a payment intent","use":"a","href":"#retrieve-payment-intent","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-08-17#cancel-payment-intent","title":"Cancel a payment intent","use":"a","href":"#cancel-payment-intent","options":{"method":"post"}}]},{"id":"/docs/api/merchant/2026-08-17#tag-apple-pay-merchant-registration","title":"Apple Pay merchant registration","use":"a","href":"#tag-apple-pay-merchant-registration","items":[{"id":"/docs/api/merchant/2026-08-17#register-domain-apple-pay","title":"Register domain for Apple Pay","use":"a","href":"#register-domain-apple-pay","options":{"method":"post"}},{"id":"/docs/api/merchant/2026-08-17#unregister-domain-apple-pay","title":"Unregister domain for Apple Pay","use":"a","href":"#unregister-domain-apple-pay","options":{"method":"post"}}]},{"id":"/docs/api/merchant/2026-08-17#tag-other","title":"Other","use":"a","href":"#tag-other","items":[{"id":"/docs/api/merchant/2026-08-17#register-address-validation-endpoint","title":"Register address validation endpoint for Fast checkout","use":"a","href":"#register-address-validation-endpoint","options":{"method":"post"}},{"id":"/docs/api/merchant/2026-08-17#retrieve-synchronous-webhook-list","title":"Retrieve a synchronous webhook list","use":"a","href":"#retrieve-synchronous-webhook-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-08-17#delete-synchronous-webhook","title":"Delete a synchronous webhook","use":"a","href":"#delete-synchronous-webhook","options":{"method":"delete"}}]}],"versions":[{"label":"2026-08-17","path":"/docs/api/merchant","latest":true},{"label":"2026-04-20","path":"/docs/api/merchant/2026-04-20","latest":false},{"label":"2026-03-12","path":"/docs/api/merchant/2026-03-12","latest":false},{"label":"2025-12-04","path":"/docs/api/merchant/2025-12-04","latest":false},{"label":"2025-10-16","path":"/docs/api/merchant/2025-10-16","latest":false},{"label":"2024-09-01","path":"/docs/api/merchant/2024-09-01","latest":false},{"label":"2024-05-01","path":"/docs/api/merchant/2024-05-01","latest":false},{"label":"2023-09-01","path":"/docs/api/merchant/2023-09-01","latest":false},{"label":"Legacy","path":"/docs/api/merchant/Legacy","latest":false}]},"/docs/api/merchant/2026-04-20":{"items":[{"id":"/docs/api/merchant/2026-04-20#tag-orders","title":"Orders","use":"a","href":"#tag-orders","items":[{"id":"/docs/api/merchant/2026-04-20#create-order","title":"Create an order","use":"a","href":"#create-order","options":{"method":"post"}},{"id":"/docs/api/merchant/2026-04-20#retrieve-order-list","title":"Retrieve an order list","use":"a","href":"#retrieve-order-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-04-20#retrieve-order","title":"Retrieve an order","use":"a","href":"#retrieve-order","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-04-20#update-order","title":"Update an order","use":"a","href":"#update-order","options":{"method":"patch"}},{"id":"/docs/api/merchant/2026-04-20#increment-authorisation","title":"Increment authorisation","use":"a","href":"#increment-authorisation","options":{"method":"post"}},{"id":"/docs/api/merchant/2026-04-20#capture-order","title":"Capture an order","use":"a","href":"#capture-order","options":{"method":"post"}},{"id":"/docs/api/merchant/2026-04-20#cancel-order","title":"Cancel an order","use":"a","href":"#cancel-order","options":{"method":"post"}},{"id":"/docs/api/merchant/2026-04-20#refund-order","title":"Refund an order","use":"a","href":"#refund-order","options":{"method":"post"}},{"id":"/docs/api/merchant/2026-04-20#pay-order","title":"Pay for an order","use":"a","href":"#pay-order","options":{"method":"post"}},{"id":"/docs/api/merchant/2026-04-20#retrieve-payment-list","title":"Retrieve payment list of an order","use":"a","href":"#retrieve-payment-list","options":{"method":"get"}}]},{"id":"/docs/api/merchant/2026-04-20#tag-customers","title":"Customers","use":"a","href":"#tag-customers","items":[{"id":"/docs/api/merchant/2026-04-20#create-customer","title":"Create a customer","use":"a","href":"#create-customer","options":{"method":"post"}},{"id":"/docs/api/merchant/2026-04-20#retrieve-customer-list","title":"Retrieve a customer list","use":"a","href":"#retrieve-customer-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-04-20#retrieve-customer","title":"Retrieve a customer","use":"a","href":"#retrieve-customer","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-04-20#update-customer","title":"Update a customer","use":"a","href":"#update-customer","options":{"method":"patch"}},{"id":"/docs/api/merchant/2026-04-20#delete-customer","title":"Delete a customer","use":"a","href":"#delete-customer","options":{"method":"delete"}},{"id":"/docs/api/merchant/2026-04-20#retrieve-payment-method-list","title":"Retrieve payment method list of a customer","use":"a","href":"#retrieve-payment-method-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-04-20#retrieve-payment-method","title":"Retrieve a customer's payment method","use":"a","href":"#retrieve-payment-method","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-04-20#update-payment-method","title":"Update a customer's payment method","use":"a","href":"#update-payment-method","options":{"method":"patch"}},{"id":"/docs/api/merchant/2026-04-20#delete-payment-method","title":"Delete a customer's payment method","use":"a","href":"#delete-payment-method","options":{"method":"delete"}}]},{"id":"/docs/api/merchant/2026-04-20#tag-payments","title":"Payments","use":"a","href":"#tag-payments","items":[{"id":"/docs/api/merchant/2026-04-20#retrieve-payment-details","title":"Retrieve payment details","use":"a","href":"#retrieve-payment-details","options":{"method":"get"}}]},{"id":"/docs/api/merchant/2026-04-20#tag-subscriptions","title":"Subscriptions","use":"a","href":"#tag-subscriptions","items":[{"id":"/docs/api/merchant/2026-04-20#create-subscription-plan","title":"Create a subscription plan","use":"a","href":"#create-subscription-plan","options":{"method":"post"}},{"id":"/docs/api/merchant/2026-04-20#retrieve-subscription-plan-list","title":"Retrieve a subscription plan list","use":"a","href":"#retrieve-subscription-plan-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-04-20#retrieve-subscription-plan","title":"Retrieve a subscription plan","use":"a","href":"#retrieve-subscription-plan","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-04-20#create-subscription","title":"Create a subscription","use":"a","href":"#create-subscription","options":{"method":"post"}},{"id":"/docs/api/merchant/2026-04-20#retrieve-subscription-list","title":"Retrieve a subscription list","use":"a","href":"#retrieve-subscription-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-04-20#retrieve-subscription","title":"Retrieve a subscription","use":"a","href":"#retrieve-subscription","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-04-20#update-subscription","title":"Update a subscription","use":"a","href":"#update-subscription","options":{"method":"patch"}},{"id":"/docs/api/merchant/2026-04-20#change-subscription-plan","title":"Change a subscription plan","use":"a","href":"#change-subscription-plan","options":{"method":"post"}},{"id":"/docs/api/merchant/2026-04-20#update-subscription-renewal-date","title":"Update a subscription renewal date","use":"a","href":"#update-subscription-renewal-date","options":{"method":"post"}},{"id":"/docs/api/merchant/2026-04-20#cancel-subscription","title":"Cancel a subscription","use":"a","href":"#cancel-subscription","options":{"method":"post"}},{"id":"/docs/api/merchant/2026-04-20#retrieve-subscription-cycle-list","title":"Retrieve a subscription cycle list","use":"a","href":"#retrieve-subscription-cycle-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-04-20#retrieve-subscription-cycle","title":"Retrieve a subscription cycle","use":"a","href":"#retrieve-subscription-cycle","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-04-20#create-subscription-usage","title":"Create a subscription usage","use":"a","href":"#create-subscription-usage","options":{"method":"post"}},{"id":"/docs/api/merchant/2026-04-20#retrieve-subscription-usage-list","title":"Retrieve a subscription usage list","use":"a","href":"#retrieve-subscription-usage-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-04-20#retrieve-subscription-usage","title":"Retrieve a subscription usage","use":"a","href":"#retrieve-subscription-usage","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-04-20#update-subscription-usage","title":"Update a subscription usage","use":"a","href":"#update-subscription-usage","options":{"method":"patch"}},{"id":"/docs/api/merchant/2026-04-20#delete-subscription-usage","title":"Delete a subscription usage","use":"a","href":"#delete-subscription-usage","options":{"method":"delete"}}]},{"id":"/docs/api/merchant/2026-04-20#tag-payouts","title":"Payouts","use":"a","href":"#tag-payouts","items":[{"id":"/docs/api/merchant/2026-04-20#retrieve-payout-list","title":"Retrieve a payout list","use":"a","href":"#retrieve-payout-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-04-20#retrieve-payout","title":"Retrieve a payout","use":"a","href":"#retrieve-payout","options":{"method":"get"}}]},{"id":"/docs/api/merchant/2026-04-20#tag-disputes","title":"Disputes","use":"a","href":"#tag-disputes","items":[{"id":"/docs/api/merchant/2026-04-20#retrieve-dispute-list","title":"Retrieve a dispute list","use":"a","href":"#retrieve-dispute-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-04-20#retrieve-dispute","title":"Retrieve a dispute","use":"a","href":"#retrieve-dispute","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-04-20#accept-dispute","title":"Accept a dispute","use":"a","href":"#accept-dispute","options":{"method":"post"}},{"id":"/docs/api/merchant/2026-04-20#upload-dispute-evidence","title":"Upload evidence for a dispute","use":"a","href":"#upload-dispute-evidence","options":{"method":"post"}},{"id":"/docs/api/merchant/2026-04-20#challenge-dispute","title":"Challenge a dispute","use":"a","href":"#challenge-dispute","options":{"method":"post"}}]},{"id":"/docs/api/merchant/2026-04-20#tag-report-runs","title":"Report runs","use":"a","href":"#tag-report-runs","items":[{"id":"/docs/api/merchant/2026-04-20#create-report-run","title":"Create a report run","use":"a","href":"#create-report-run","options":{"method":"post"}},{"id":"/docs/api/merchant/2026-04-20#retrieve-report-run","title":"Retrieve a report run","use":"a","href":"#retrieve-report-run","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-04-20#download-report-file","title":"Download report file","use":"a","href":"#download-report-file","options":{"method":"get"}}]},{"id":"/docs/api/merchant/2026-04-20#tag-webhooks","title":"Webhooks","use":"a","href":"#tag-webhooks","items":[{"id":"/docs/api/merchant/2026-04-20#create-webhook","title":"Create a webhook","use":"a","href":"#create-webhook","options":{"method":"post"}},{"id":"/docs/api/merchant/2026-04-20#retrieve-webhook-list","title":"Retrieve a webhook list","use":"a","href":"#retrieve-webhook-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-04-20#retrieve-webhook","title":"Retrieve a webhook","use":"a","href":"#retrieve-webhook","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-04-20#update-webhook","title":"Update a webhook","use":"a","href":"#update-webhook","options":{"method":"patch"}},{"id":"/docs/api/merchant/2026-04-20#delete-webhook","title":"Delete a webhook","use":"a","href":"#delete-webhook","options":{"method":"delete"}},{"id":"/docs/api/merchant/2026-04-20#rotate-webhook-signing-secret","title":"Rotate a webhook signing secret","use":"a","href":"#rotate-webhook-signing-secret","options":{"method":"post"}},{"id":"/docs/api/merchant/2026-04-20#webhook-webhook-event","title":"Webhook event","use":"a","href":"#webhook-webhook-event","options":{"method":"webhook"}}]},{"id":"/docs/api/merchant/2026-04-20#tag-locations","title":"Locations","use":"a","href":"#tag-locations","items":[{"id":"/docs/api/merchant/2026-04-20#create-location","title":"Create a location","use":"a","href":"#create-location","options":{"method":"post"}},{"id":"/docs/api/merchant/2026-04-20#retrieve-location-list","title":"Retrieve location list","use":"a","href":"#retrieve-location-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-04-20#retrieve-location","title":"Retrieve a location","use":"a","href":"#retrieve-location","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-04-20#update-location","title":"Update a location","use":"a","href":"#update-location","options":{"method":"patch"}},{"id":"/docs/api/merchant/2026-04-20#delete-location","title":"Delete a location","use":"a","href":"#delete-location","options":{"method":"delete"}}]},{"id":"/docs/api/merchant/2026-04-20#tag-terminals","title":"Terminals","use":"a","href":"#tag-terminals","items":[{"id":"/docs/api/merchant/2026-04-20#retrieve-terminal-list","title":"Retrieve terminal list","use":"a","href":"#retrieve-terminal-list","options":{"method":"get"}}]},{"id":"/docs/api/merchant/2026-04-20#tag-payment-intents","title":"Payment intents","use":"a","href":"#tag-payment-intents","items":[{"id":"/docs/api/merchant/2026-04-20#create-payment-intent","title":"Create a payment intent","use":"a","href":"#create-payment-intent","options":{"method":"post"}},{"id":"/docs/api/merchant/2026-04-20#retrieve-payment-intent","title":"Retrieve a payment intent","use":"a","href":"#retrieve-payment-intent","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-04-20#cancel-payment-intent","title":"Cancel a payment intent","use":"a","href":"#cancel-payment-intent","options":{"method":"post"}}]},{"id":"/docs/api/merchant/2026-04-20#tag-apple-pay-merchant-registration","title":"Apple Pay merchant registration","use":"a","href":"#tag-apple-pay-merchant-registration","items":[{"id":"/docs/api/merchant/2026-04-20#register-domain-apple-pay","title":"Register domain for Apple Pay","use":"a","href":"#register-domain-apple-pay","options":{"method":"post"}},{"id":"/docs/api/merchant/2026-04-20#unregister-domain-apple-pay","title":"Unregister domain for Apple Pay","use":"a","href":"#unregister-domain-apple-pay","options":{"method":"post"}}]},{"id":"/docs/api/merchant/2026-04-20#tag-other","title":"Other","use":"a","href":"#tag-other","items":[{"id":"/docs/api/merchant/2026-04-20#register-address-validation-endpoint","title":"Register address validation endpoint for Fast checkout","use":"a","href":"#register-address-validation-endpoint","options":{"method":"post"}},{"id":"/docs/api/merchant/2026-04-20#retrieve-synchronous-webhook-list","title":"Retrieve a synchronous webhook list","use":"a","href":"#retrieve-synchronous-webhook-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-04-20#delete-synchronous-webhook","title":"Delete a synchronous webhook","use":"a","href":"#delete-synchronous-webhook","options":{"method":"delete"}}]}],"versions":[{"label":"2026-08-17","path":"/docs/api/merchant","latest":true},{"label":"2026-04-20","path":"/docs/api/merchant/2026-04-20","latest":false},{"label":"2026-03-12","path":"/docs/api/merchant/2026-03-12","latest":false},{"label":"2025-12-04","path":"/docs/api/merchant/2025-12-04","latest":false},{"label":"2025-10-16","path":"/docs/api/merchant/2025-10-16","latest":false},{"label":"2024-09-01","path":"/docs/api/merchant/2024-09-01","latest":false},{"label":"2024-05-01","path":"/docs/api/merchant/2024-05-01","latest":false},{"label":"2023-09-01","path":"/docs/api/merchant/2023-09-01","latest":false},{"label":"Legacy","path":"/docs/api/merchant/Legacy","latest":false}]},"/docs/api/merchant/2026-03-12":{"items":[{"id":"/docs/api/merchant/2026-03-12#tag-orders","title":"Orders","use":"a","href":"#tag-orders","items":[{"id":"/docs/api/merchant/2026-03-12#create-order","title":"Create an order","use":"a","href":"#create-order","options":{"method":"post"}},{"id":"/docs/api/merchant/2026-03-12#retrieve-order-list","title":"Retrieve an order list","use":"a","href":"#retrieve-order-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-03-12#retrieve-order","title":"Retrieve an order","use":"a","href":"#retrieve-order","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-03-12#update-order","title":"Update an order","use":"a","href":"#update-order","options":{"method":"patch"}},{"id":"/docs/api/merchant/2026-03-12#increment-authorisation","title":"Increment authorisation","use":"a","href":"#increment-authorisation","options":{"method":"post"}},{"id":"/docs/api/merchant/2026-03-12#capture-order","title":"Capture an order","use":"a","href":"#capture-order","options":{"method":"post"}},{"id":"/docs/api/merchant/2026-03-12#cancel-order","title":"Cancel an order","use":"a","href":"#cancel-order","options":{"method":"post"}},{"id":"/docs/api/merchant/2026-03-12#refund-order","title":"Refund an order","use":"a","href":"#refund-order","options":{"method":"post"}},{"id":"/docs/api/merchant/2026-03-12#pay-order","title":"Pay for an order","use":"a","href":"#pay-order","options":{"method":"post"}},{"id":"/docs/api/merchant/2026-03-12#retrieve-payment-list","title":"Retrieve payment list of an order","use":"a","href":"#retrieve-payment-list","options":{"method":"get"}}]},{"id":"/docs/api/merchant/2026-03-12#tag-customers","title":"Customers","use":"a","href":"#tag-customers","items":[{"id":"/docs/api/merchant/2026-03-12#create-customer","title":"Create a customer","use":"a","href":"#create-customer","options":{"method":"post"}},{"id":"/docs/api/merchant/2026-03-12#retrieve-customer-list","title":"Retrieve a customer list","use":"a","href":"#retrieve-customer-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-03-12#retrieve-customer","title":"Retrieve a customer","use":"a","href":"#retrieve-customer","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-03-12#update-customer","title":"Update a customer","use":"a","href":"#update-customer","options":{"method":"patch"}},{"id":"/docs/api/merchant/2026-03-12#delete-customer","title":"Delete a customer","use":"a","href":"#delete-customer","options":{"method":"delete"}},{"id":"/docs/api/merchant/2026-03-12#retrieve-payment-method-list","title":"Retrieve payment method list of a customer","use":"a","href":"#retrieve-payment-method-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-03-12#retrieve-payment-method","title":"Retrieve a customer's payment method","use":"a","href":"#retrieve-payment-method","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-03-12#update-payment-method","title":"Update a customer's payment method","use":"a","href":"#update-payment-method","options":{"method":"patch"}},{"id":"/docs/api/merchant/2026-03-12#delete-payment-method","title":"Delete a customer's payment method","use":"a","href":"#delete-payment-method","options":{"method":"delete"}}]},{"id":"/docs/api/merchant/2026-03-12#tag-payments","title":"Payments","use":"a","href":"#tag-payments","items":[{"id":"/docs/api/merchant/2026-03-12#retrieve-payment-details","title":"Retrieve payment details","use":"a","href":"#retrieve-payment-details","options":{"method":"get"}}]},{"id":"/docs/api/merchant/2026-03-12#tag-subscriptions","title":"Subscriptions","use":"a","href":"#tag-subscriptions","items":[{"id":"/docs/api/merchant/2026-03-12#create-subscription-plan","title":"Create a subscription plan","use":"a","href":"#create-subscription-plan","options":{"method":"post"}},{"id":"/docs/api/merchant/2026-03-12#retrieve-subscription-plan-list","title":"Retrieve a subscription plan list","use":"a","href":"#retrieve-subscription-plan-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-03-12#retrieve-subscription-plan","title":"Retrieve a subscription plan","use":"a","href":"#retrieve-subscription-plan","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-03-12#create-subscription","title":"Create a subscription","use":"a","href":"#create-subscription","options":{"method":"post"}},{"id":"/docs/api/merchant/2026-03-12#retrieve-subscription-list","title":"Retrieve a subscription list","use":"a","href":"#retrieve-subscription-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-03-12#retrieve-subscription","title":"Retrieve a subscription","use":"a","href":"#retrieve-subscription","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-03-12#update-subscription","title":"Update a subscription","use":"a","href":"#update-subscription","options":{"method":"patch"}},{"id":"/docs/api/merchant/2026-03-12#change-subscription-plan","title":"Change a subscription plan","use":"a","href":"#change-subscription-plan","options":{"method":"post"}},{"id":"/docs/api/merchant/2026-03-12#update-subscription-renewal-date","title":"Update a subscription renewal date","use":"a","href":"#update-subscription-renewal-date","options":{"method":"post"}},{"id":"/docs/api/merchant/2026-03-12#cancel-subscription","title":"Cancel a subscription","use":"a","href":"#cancel-subscription","options":{"method":"post"}},{"id":"/docs/api/merchant/2026-03-12#retrieve-subscription-cycle-list","title":"Retrieve a subscription cycle list","use":"a","href":"#retrieve-subscription-cycle-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-03-12#retrieve-subscription-cycle","title":"Retrieve a subscription cycle","use":"a","href":"#retrieve-subscription-cycle","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-03-12#create-subscription-usage","title":"Create a subscription usage","use":"a","href":"#create-subscription-usage","options":{"method":"post"}},{"id":"/docs/api/merchant/2026-03-12#retrieve-subscription-usage-list","title":"Retrieve a subscription usage list","use":"a","href":"#retrieve-subscription-usage-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-03-12#retrieve-subscription-usage","title":"Retrieve a subscription usage","use":"a","href":"#retrieve-subscription-usage","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-03-12#update-subscription-usage","title":"Update a subscription usage","use":"a","href":"#update-subscription-usage","options":{"method":"patch"}},{"id":"/docs/api/merchant/2026-03-12#delete-subscription-usage","title":"Delete a subscription usage","use":"a","href":"#delete-subscription-usage","options":{"method":"delete"}}]},{"id":"/docs/api/merchant/2026-03-12#tag-payouts","title":"Payouts","use":"a","href":"#tag-payouts","items":[{"id":"/docs/api/merchant/2026-03-12#retrieve-payout-list","title":"Retrieve a payout list","use":"a","href":"#retrieve-payout-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-03-12#retrieve-payout","title":"Retrieve a payout","use":"a","href":"#retrieve-payout","options":{"method":"get"}}]},{"id":"/docs/api/merchant/2026-03-12#tag-disputes","title":"Disputes","use":"a","href":"#tag-disputes","items":[{"id":"/docs/api/merchant/2026-03-12#retrieve-dispute-list","title":"Retrieve a dispute list","use":"a","href":"#retrieve-dispute-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-03-12#retrieve-dispute","title":"Retrieve a dispute","use":"a","href":"#retrieve-dispute","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-03-12#accept-dispute","title":"Accept a dispute","use":"a","href":"#accept-dispute","options":{"method":"post"}},{"id":"/docs/api/merchant/2026-03-12#upload-dispute-evidence","title":"Upload evidence for a dispute","use":"a","href":"#upload-dispute-evidence","options":{"method":"post"}},{"id":"/docs/api/merchant/2026-03-12#challenge-dispute","title":"Challenge a dispute","use":"a","href":"#challenge-dispute","options":{"method":"post"}}]},{"id":"/docs/api/merchant/2026-03-12#tag-report-runs","title":"Report runs","use":"a","href":"#tag-report-runs","items":[{"id":"/docs/api/merchant/2026-03-12#create-report-run","title":"Create a report run","use":"a","href":"#create-report-run","options":{"method":"post"}},{"id":"/docs/api/merchant/2026-03-12#retrieve-report-run","title":"Retrieve a report run","use":"a","href":"#retrieve-report-run","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-03-12#download-report-file","title":"Download report file","use":"a","href":"#download-report-file","options":{"method":"get"}}]},{"id":"/docs/api/merchant/2026-03-12#tag-webhooks","title":"Webhooks","use":"a","href":"#tag-webhooks","items":[{"id":"/docs/api/merchant/2026-03-12#create-webhook","title":"Create a webhook","use":"a","href":"#create-webhook","options":{"method":"post"}},{"id":"/docs/api/merchant/2026-03-12#retrieve-webhook-list","title":"Retrieve a webhook list","use":"a","href":"#retrieve-webhook-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-03-12#retrieve-webhook","title":"Retrieve a webhook","use":"a","href":"#retrieve-webhook","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-03-12#update-webhook","title":"Update a webhook","use":"a","href":"#update-webhook","options":{"method":"patch"}},{"id":"/docs/api/merchant/2026-03-12#delete-webhook","title":"Delete a webhook","use":"a","href":"#delete-webhook","options":{"method":"delete"}},{"id":"/docs/api/merchant/2026-03-12#rotate-webhook-signing-secret","title":"Rotate a webhook signing secret","use":"a","href":"#rotate-webhook-signing-secret","options":{"method":"post"}},{"id":"/docs/api/merchant/2026-03-12#webhook-webhook-event","title":"Webhook event","use":"a","href":"#webhook-webhook-event","options":{"method":"webhook"}}]},{"id":"/docs/api/merchant/2026-03-12#tag-locations","title":"Locations","use":"a","href":"#tag-locations","items":[{"id":"/docs/api/merchant/2026-03-12#create-location","title":"Create a location","use":"a","href":"#create-location","options":{"method":"post"}},{"id":"/docs/api/merchant/2026-03-12#retrieve-location-list","title":"Retrieve location list","use":"a","href":"#retrieve-location-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-03-12#retrieve-location","title":"Retrieve a location","use":"a","href":"#retrieve-location","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-03-12#update-location","title":"Update a location","use":"a","href":"#update-location","options":{"method":"patch"}},{"id":"/docs/api/merchant/2026-03-12#delete-location","title":"Delete a location","use":"a","href":"#delete-location","options":{"method":"delete"}}]},{"id":"/docs/api/merchant/2026-03-12#tag-terminals","title":"Terminals","use":"a","href":"#tag-terminals","items":[{"id":"/docs/api/merchant/2026-03-12#retrieve-terminal-list","title":"Retrieve terminal list","use":"a","href":"#retrieve-terminal-list","options":{"method":"get"}}]},{"id":"/docs/api/merchant/2026-03-12#tag-payment-intents","title":"Payment intents","use":"a","href":"#tag-payment-intents","items":[{"id":"/docs/api/merchant/2026-03-12#create-payment-intent","title":"Create a payment intent","use":"a","href":"#create-payment-intent","options":{"method":"post"}},{"id":"/docs/api/merchant/2026-03-12#retrieve-payment-intent","title":"Retrieve a payment intent","use":"a","href":"#retrieve-payment-intent","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-03-12#cancel-payment-intent","title":"Cancel a payment intent","use":"a","href":"#cancel-payment-intent","options":{"method":"post"}}]},{"id":"/docs/api/merchant/2026-03-12#tag-apple-pay-merchant-registration","title":"Apple Pay merchant registration","use":"a","href":"#tag-apple-pay-merchant-registration","items":[{"id":"/docs/api/merchant/2026-03-12#register-domain-apple-pay","title":"Register domain for Apple Pay","use":"a","href":"#register-domain-apple-pay","options":{"method":"post"}},{"id":"/docs/api/merchant/2026-03-12#unregister-domain-apple-pay","title":"Unregister domain for Apple Pay","use":"a","href":"#unregister-domain-apple-pay","options":{"method":"post"}}]},{"id":"/docs/api/merchant/2026-03-12#tag-other","title":"Other","use":"a","href":"#tag-other","items":[{"id":"/docs/api/merchant/2026-03-12#register-address-validation-endpoint","title":"Register address validation endpoint for Fast checkout","use":"a","href":"#register-address-validation-endpoint","options":{"method":"post"}},{"id":"/docs/api/merchant/2026-03-12#retrieve-synchronous-webhook-list","title":"Retrieve a synchronous webhook list","use":"a","href":"#retrieve-synchronous-webhook-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2026-03-12#delete-synchronous-webhook","title":"Delete a synchronous webhook","use":"a","href":"#delete-synchronous-webhook","options":{"method":"delete"}}]}],"versions":[{"label":"2026-08-17","path":"/docs/api/merchant","latest":true},{"label":"2026-04-20","path":"/docs/api/merchant/2026-04-20","latest":false},{"label":"2026-03-12","path":"/docs/api/merchant/2026-03-12","latest":false},{"label":"2025-12-04","path":"/docs/api/merchant/2025-12-04","latest":false},{"label":"2025-10-16","path":"/docs/api/merchant/2025-10-16","latest":false},{"label":"2024-09-01","path":"/docs/api/merchant/2024-09-01","latest":false},{"label":"2024-05-01","path":"/docs/api/merchant/2024-05-01","latest":false},{"label":"2023-09-01","path":"/docs/api/merchant/2023-09-01","latest":false},{"label":"Legacy","path":"/docs/api/merchant/Legacy","latest":false}]},"/docs/api/merchant/2025-12-04":{"items":[{"id":"/docs/api/merchant/2025-12-04#tag-orders","title":"Orders","use":"a","href":"#tag-orders","items":[{"id":"/docs/api/merchant/2025-12-04#create-order","title":"Create an order","use":"a","href":"#create-order","options":{"method":"post"}},{"id":"/docs/api/merchant/2025-12-04#retrieve-order-list","title":"Retrieve an order list","use":"a","href":"#retrieve-order-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2025-12-04#retrieve-order","title":"Retrieve an order","use":"a","href":"#retrieve-order","options":{"method":"get"}},{"id":"/docs/api/merchant/2025-12-04#update-order","title":"Update an order","use":"a","href":"#update-order","options":{"method":"patch"}},{"id":"/docs/api/merchant/2025-12-04#increment-authorisation","title":"Increment authorisation","use":"a","href":"#increment-authorisation","options":{"method":"post"}},{"id":"/docs/api/merchant/2025-12-04#capture-order","title":"Capture an order","use":"a","href":"#capture-order","options":{"method":"post"}},{"id":"/docs/api/merchant/2025-12-04#cancel-order","title":"Cancel an order","use":"a","href":"#cancel-order","options":{"method":"post"}},{"id":"/docs/api/merchant/2025-12-04#refund-order","title":"Refund an order","use":"a","href":"#refund-order","options":{"method":"post"}},{"id":"/docs/api/merchant/2025-12-04#pay-order","title":"Pay for an order","use":"a","href":"#pay-order","options":{"method":"post"}},{"id":"/docs/api/merchant/2025-12-04#retrieve-payment-list","title":"Retrieve payment list of an order","use":"a","href":"#retrieve-payment-list","options":{"method":"get"}}]},{"id":"/docs/api/merchant/2025-12-04#tag-customers","title":"Customers","use":"a","href":"#tag-customers","items":[{"id":"/docs/api/merchant/2025-12-04#create-customer","title":"Create a customer","use":"a","href":"#create-customer","options":{"method":"post"}},{"id":"/docs/api/merchant/2025-12-04#retrieve-customer-list","title":"Retrieve a customer list","use":"a","href":"#retrieve-customer-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2025-12-04#retrieve-customer","title":"Retrieve a customer","use":"a","href":"#retrieve-customer","options":{"method":"get"}},{"id":"/docs/api/merchant/2025-12-04#update-customer","title":"Update a customer","use":"a","href":"#update-customer","options":{"method":"patch"}},{"id":"/docs/api/merchant/2025-12-04#delete-customer","title":"Delete a customer","use":"a","href":"#delete-customer","options":{"method":"delete"}},{"id":"/docs/api/merchant/2025-12-04#retrieve-payment-method-list","title":"Retrieve payment method list of a customer","use":"a","href":"#retrieve-payment-method-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2025-12-04#retrieve-payment-method","title":"Retrieve a customer's payment method","use":"a","href":"#retrieve-payment-method","options":{"method":"get"}},{"id":"/docs/api/merchant/2025-12-04#update-payment-method","title":"Update a customer's payment method","use":"a","href":"#update-payment-method","options":{"method":"patch"}},{"id":"/docs/api/merchant/2025-12-04#delete-payment-method","title":"Delete a customer's payment method","use":"a","href":"#delete-payment-method","options":{"method":"delete"}}]},{"id":"/docs/api/merchant/2025-12-04#tag-payments","title":"Payments","use":"a","href":"#tag-payments","items":[{"id":"/docs/api/merchant/2025-12-04#retrieve-payment-details","title":"Retrieve payment details","use":"a","href":"#retrieve-payment-details","options":{"method":"get"}}]},{"id":"/docs/api/merchant/2025-12-04#tag-subscriptions","title":"Subscriptions","use":"a","href":"#tag-subscriptions","items":[{"id":"/docs/api/merchant/2025-12-04#create-subscription-plan","title":"Create a subscription plan","use":"a","href":"#create-subscription-plan","options":{"method":"post"}},{"id":"/docs/api/merchant/2025-12-04#retrieve-subscription-plan-list","title":"Retrieve a subscription plan list","use":"a","href":"#retrieve-subscription-plan-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2025-12-04#retrieve-subscription-plan","title":"Retrieve a subscription plan","use":"a","href":"#retrieve-subscription-plan","options":{"method":"get"}},{"id":"/docs/api/merchant/2025-12-04#create-subscription","title":"Create a subscription","use":"a","href":"#create-subscription","options":{"method":"post"}},{"id":"/docs/api/merchant/2025-12-04#retrieve-subscription-list","title":"Retrieve a subscription list","use":"a","href":"#retrieve-subscription-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2025-12-04#retrieve-subscription","title":"Retrieve a subscription","use":"a","href":"#retrieve-subscription","options":{"method":"get"}},{"id":"/docs/api/merchant/2025-12-04#update-subscription","title":"Update a subscription","use":"a","href":"#update-subscription","options":{"method":"patch"}},{"id":"/docs/api/merchant/2025-12-04#cancel-subscription","title":"Cancel a subscription","use":"a","href":"#cancel-subscription","options":{"method":"post"}},{"id":"/docs/api/merchant/2025-12-04#change-subscription-plan","title":"Change a subscription plan","use":"a","href":"#change-subscription-plan","options":{"method":"post"}},{"id":"/docs/api/merchant/2025-12-04#update-subscription-renewal-date","title":"Update a subscription renewal date","use":"a","href":"#update-subscription-renewal-date","options":{"method":"post"}},{"id":"/docs/api/merchant/2025-12-04#retrieve-subscription-cycle-list","title":"Retrieve a subscription cycle list","use":"a","href":"#retrieve-subscription-cycle-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2025-12-04#retrieve-subscription-cycle","title":"Retrieve a subscription cycle","use":"a","href":"#retrieve-subscription-cycle","options":{"method":"get"}},{"id":"/docs/api/merchant/2025-12-04#create-subscription-usage","title":"Create a subscription usage","use":"a","href":"#create-subscription-usage","options":{"method":"post"}},{"id":"/docs/api/merchant/2025-12-04#retrieve-subscription-usage-list","title":"Retrieve a subscription usage list","use":"a","href":"#retrieve-subscription-usage-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2025-12-04#retrieve-subscription-usage","title":"Retrieve a subscription usage","use":"a","href":"#retrieve-subscription-usage","options":{"method":"get"}},{"id":"/docs/api/merchant/2025-12-04#update-subscription-usage","title":"Update a subscription usage","use":"a","href":"#update-subscription-usage","options":{"method":"patch"}},{"id":"/docs/api/merchant/2025-12-04#delete-subscription-usage","title":"Delete a subscription usage","use":"a","href":"#delete-subscription-usage","options":{"method":"delete"}}]},{"id":"/docs/api/merchant/2025-12-04#tag-payouts","title":"Payouts","use":"a","href":"#tag-payouts","items":[{"id":"/docs/api/merchant/2025-12-04#retrieve-payout-list","title":"Retrieve a payout list","use":"a","href":"#retrieve-payout-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2025-12-04#retrieve-payout","title":"Retrieve a payout","use":"a","href":"#retrieve-payout","options":{"method":"get"}}]},{"id":"/docs/api/merchant/2025-12-04#tag-disputes","title":"Disputes","use":"a","href":"#tag-disputes","items":[{"id":"/docs/api/merchant/2025-12-04#retrieve-dispute-list","title":"Retrieve a dispute list","use":"a","href":"#retrieve-dispute-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2025-12-04#retrieve-dispute","title":"Retrieve a dispute","use":"a","href":"#retrieve-dispute","options":{"method":"get"}},{"id":"/docs/api/merchant/2025-12-04#accept-dispute","title":"Accept a dispute","use":"a","href":"#accept-dispute","options":{"method":"post"}},{"id":"/docs/api/merchant/2025-12-04#upload-dispute-evidence","title":"Upload evidence for a dispute","use":"a","href":"#upload-dispute-evidence","options":{"method":"post"}},{"id":"/docs/api/merchant/2025-12-04#challenge-dispute","title":"Challenge a dispute","use":"a","href":"#challenge-dispute","options":{"method":"post"}}]},{"id":"/docs/api/merchant/2025-12-04#tag-report-runs","title":"Report runs","use":"a","href":"#tag-report-runs","items":[{"id":"/docs/api/merchant/2025-12-04#create-report-run","title":"Create a report run","use":"a","href":"#create-report-run","options":{"method":"post"}},{"id":"/docs/api/merchant/2025-12-04#retrieve-report-run","title":"Retrieve a report run","use":"a","href":"#retrieve-report-run","options":{"method":"get"}},{"id":"/docs/api/merchant/2025-12-04#download-report-file","title":"Download report file","use":"a","href":"#download-report-file","options":{"method":"get"}}]},{"id":"/docs/api/merchant/2025-12-04#tag-webhooks","title":"Webhooks","use":"a","href":"#tag-webhooks","items":[{"id":"/docs/api/merchant/2025-12-04#create-webhook","title":"Create a webhook","use":"a","href":"#create-webhook","options":{"method":"post"}},{"id":"/docs/api/merchant/2025-12-04#retrieve-webhook-list","title":"Retrieve a webhook list","use":"a","href":"#retrieve-webhook-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2025-12-04#retrieve-webhook","title":"Retrieve a webhook","use":"a","href":"#retrieve-webhook","options":{"method":"get"}},{"id":"/docs/api/merchant/2025-12-04#update-webhook","title":"Update a webhook","use":"a","href":"#update-webhook","options":{"method":"patch"}},{"id":"/docs/api/merchant/2025-12-04#delete-webhook","title":"Delete a webhook","use":"a","href":"#delete-webhook","options":{"method":"delete"}},{"id":"/docs/api/merchant/2025-12-04#rotate-webhook-signing-secret","title":"Rotate a webhook signing secret","use":"a","href":"#rotate-webhook-signing-secret","options":{"method":"post"}},{"id":"/docs/api/merchant/2025-12-04#webhook-webhook-event","title":"Webhook event","use":"a","href":"#webhook-webhook-event","options":{"method":"webhook"}}]},{"id":"/docs/api/merchant/2025-12-04#tag-locations","title":"Locations","use":"a","href":"#tag-locations","items":[{"id":"/docs/api/merchant/2025-12-04#create-location","title":"Create a location","use":"a","href":"#create-location","options":{"method":"post"}},{"id":"/docs/api/merchant/2025-12-04#retrieve-location-list","title":"Retrieve location list","use":"a","href":"#retrieve-location-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2025-12-04#retrieve-location","title":"Retrieve a location","use":"a","href":"#retrieve-location","options":{"method":"get"}},{"id":"/docs/api/merchant/2025-12-04#update-location","title":"Update a location","use":"a","href":"#update-location","options":{"method":"patch"}},{"id":"/docs/api/merchant/2025-12-04#delete-location","title":"Delete a location","use":"a","href":"#delete-location","options":{"method":"delete"}}]},{"id":"/docs/api/merchant/2025-12-04#tag-terminals","title":"Terminals","use":"a","href":"#tag-terminals","items":[{"id":"/docs/api/merchant/2025-12-04#retrieve-terminal-list","title":"Retrieve terminal list","use":"a","href":"#retrieve-terminal-list","options":{"method":"get"}}]},{"id":"/docs/api/merchant/2025-12-04#tag-payment-intents","title":"Payment intents","use":"a","href":"#tag-payment-intents","items":[{"id":"/docs/api/merchant/2025-12-04#create-payment-intent","title":"Create a payment intent","use":"a","href":"#create-payment-intent","options":{"method":"post"}},{"id":"/docs/api/merchant/2025-12-04#retrieve-payment-intent","title":"Retrieve a payment intent","use":"a","href":"#retrieve-payment-intent","options":{"method":"get"}},{"id":"/docs/api/merchant/2025-12-04#cancel-payment-intent","title":"Cancel a payment intent","use":"a","href":"#cancel-payment-intent","options":{"method":"post"}}]},{"id":"/docs/api/merchant/2025-12-04#tag-apple-pay-merchant-registration","title":"Apple Pay merchant registration","use":"a","href":"#tag-apple-pay-merchant-registration","items":[{"id":"/docs/api/merchant/2025-12-04#register-domain-apple-pay","title":"Register domain for Apple Pay","use":"a","href":"#register-domain-apple-pay","options":{"method":"post"}},{"id":"/docs/api/merchant/2025-12-04#unregister-domain-apple-pay","title":"Unregister domain for Apple Pay","use":"a","href":"#unregister-domain-apple-pay","options":{"method":"post"}}]},{"id":"/docs/api/merchant/2025-12-04#tag-other","title":"Other","use":"a","href":"#tag-other","items":[{"id":"/docs/api/merchant/2025-12-04#register-address-validation-endpoint","title":"Register address validation endpoint for Fast checkout","use":"a","href":"#register-address-validation-endpoint","options":{"method":"post"}},{"id":"/docs/api/merchant/2025-12-04#retrieve-synchronous-webhook-list","title":"Retrieve a synchronous webhook list","use":"a","href":"#retrieve-synchronous-webhook-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2025-12-04#delete-synchronous-webhook","title":"Delete a synchronous webhook","use":"a","href":"#delete-synchronous-webhook","options":{"method":"delete"}}]}],"versions":[{"label":"2026-08-17","path":"/docs/api/merchant","latest":true},{"label":"2026-04-20","path":"/docs/api/merchant/2026-04-20","latest":false},{"label":"2026-03-12","path":"/docs/api/merchant/2026-03-12","latest":false},{"label":"2025-12-04","path":"/docs/api/merchant/2025-12-04","latest":false},{"label":"2025-10-16","path":"/docs/api/merchant/2025-10-16","latest":false},{"label":"2024-09-01","path":"/docs/api/merchant/2024-09-01","latest":false},{"label":"2024-05-01","path":"/docs/api/merchant/2024-05-01","latest":false},{"label":"2023-09-01","path":"/docs/api/merchant/2023-09-01","latest":false},{"label":"Legacy","path":"/docs/api/merchant/Legacy","latest":false}]},"/docs/api/merchant/2025-10-16":{"items":[{"id":"/docs/api/merchant/2025-10-16#tag-orders","title":"Orders","use":"a","href":"#tag-orders","items":[{"id":"/docs/api/merchant/2025-10-16#create-order","title":"Create an order","use":"a","href":"#create-order","options":{"method":"post"}},{"id":"/docs/api/merchant/2025-10-16#retrieve-order-list","title":"Retrieve an order list","use":"a","href":"#retrieve-order-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2025-10-16#retrieve-order","title":"Retrieve an order","use":"a","href":"#retrieve-order","options":{"method":"get"}},{"id":"/docs/api/merchant/2025-10-16#update-order","title":"Update an order","use":"a","href":"#update-order","options":{"method":"patch"}},{"id":"/docs/api/merchant/2025-10-16#increment-order-authorisation","title":"Increment authorisation","use":"a","href":"#increment-order-authorisation","options":{"method":"post"}},{"id":"/docs/api/merchant/2025-10-16#capture-order","title":"Capture an order","use":"a","href":"#capture-order","options":{"method":"post"}},{"id":"/docs/api/merchant/2025-10-16#cancel-order","title":"Cancel an order","use":"a","href":"#cancel-order","options":{"method":"post"}},{"id":"/docs/api/merchant/2025-10-16#refund-order","title":"Refund an order","use":"a","href":"#refund-order","options":{"method":"post"}},{"id":"/docs/api/merchant/2025-10-16#pay-order","title":"Pay for an order","use":"a","href":"#pay-order","options":{"method":"post"}},{"id":"/docs/api/merchant/2025-10-16#retrieve-payment-list","title":"Retrieve payment list of an order","use":"a","href":"#retrieve-payment-list","options":{"method":"get"}}]},{"id":"/docs/api/merchant/2025-10-16#tag-customers","title":"Customers","use":"a","href":"#tag-customers","items":[{"id":"/docs/api/merchant/2025-10-16#create-customer","title":"Create a customer","use":"a","href":"#create-customer","options":{"method":"post"}},{"id":"/docs/api/merchant/2025-10-16#retrieve-customer-list","title":"Retrieve a customer list","use":"a","href":"#retrieve-customer-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2025-10-16#retrieve-customer","title":"Retrieve a customer","use":"a","href":"#retrieve-customer","options":{"method":"get"}},{"id":"/docs/api/merchant/2025-10-16#update-customer","title":"Update a customer","use":"a","href":"#update-customer","options":{"method":"patch"}},{"id":"/docs/api/merchant/2025-10-16#delete-customer","title":"Delete a customer","use":"a","href":"#delete-customer","options":{"method":"delete"}},{"id":"/docs/api/merchant/2025-10-16#retrieve-payment-method-list","title":"Retrieve payment method list of a customer","use":"a","href":"#retrieve-payment-method-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2025-10-16#retrieve-payment-method","title":"Retrieve a customer's payment method","use":"a","href":"#retrieve-payment-method","options":{"method":"get"}},{"id":"/docs/api/merchant/2025-10-16#update-payment-method","title":"Update a customer's payment method","use":"a","href":"#update-payment-method","options":{"method":"patch"}},{"id":"/docs/api/merchant/2025-10-16#delete-payment-method","title":"Delete a customer's payment method","use":"a","href":"#delete-payment-method","options":{"method":"delete"}}]},{"id":"/docs/api/merchant/2025-10-16#tag-payments","title":"Payments","use":"a","href":"#tag-payments","items":[{"id":"/docs/api/merchant/2025-10-16#retrieve-payment-details","title":"Retrieve payment details","use":"a","href":"#retrieve-payment-details","options":{"method":"get"}}]},{"id":"/docs/api/merchant/2025-10-16#tag-subscriptions","title":"Subscriptions","use":"a","href":"#tag-subscriptions","items":[{"id":"/docs/api/merchant/2025-10-16#create-subscription-plan","title":"Create a subscription plan","use":"a","href":"#create-subscription-plan","options":{"method":"post"}},{"id":"/docs/api/merchant/2025-10-16#retrieve-subscription-plan-list","title":"Retrieve a subscription plan list","use":"a","href":"#retrieve-subscription-plan-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2025-10-16#retrieve-subscription-plan","title":"Retrieve a subscription plan","use":"a","href":"#retrieve-subscription-plan","options":{"method":"get"}},{"id":"/docs/api/merchant/2025-10-16#create-subscription","title":"Create a subscription","use":"a","href":"#create-subscription","options":{"method":"post"}},{"id":"/docs/api/merchant/2025-10-16#retrieve-subscription-list","title":"Retrieve a subscription list","use":"a","href":"#retrieve-subscription-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2025-10-16#retrieve-subscription","title":"Retrieve a subscription","use":"a","href":"#retrieve-subscription","options":{"method":"get"}},{"id":"/docs/api/merchant/2025-10-16#update-subscription","title":"Update a subscription","use":"a","href":"#update-subscription","options":{"method":"patch"}},{"id":"/docs/api/merchant/2025-10-16#cancel-subscription","title":"Cancel a subscription","use":"a","href":"#cancel-subscription","options":{"method":"post"}},{"id":"/docs/api/merchant/2025-10-16#change-subscription-plan","title":"Change a subscription plan","use":"a","href":"#change-subscription-plan","options":{"method":"post"}},{"id":"/docs/api/merchant/2025-10-16#update-subscription-renewal-date","title":"Update a subscription renewal date","use":"a","href":"#update-subscription-renewal-date","options":{"method":"post"}},{"id":"/docs/api/merchant/2025-10-16#retrieve-subscription-cycle-list","title":"Retrieve a subscription cycle list","use":"a","href":"#retrieve-subscription-cycle-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2025-10-16#retrieve-subscription-cycle","title":"Retrieve a subscription cycle","use":"a","href":"#retrieve-subscription-cycle","options":{"method":"get"}},{"id":"/docs/api/merchant/2025-10-16#create-subscription-usage","title":"Create a subscription usage","use":"a","href":"#create-subscription-usage","options":{"method":"post"}},{"id":"/docs/api/merchant/2025-10-16#retrieve-subscription-usage-list","title":"Retrieve a subscription usage list","use":"a","href":"#retrieve-subscription-usage-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2025-10-16#retrieve-subscription-usage","title":"Retrieve a subscription usage","use":"a","href":"#retrieve-subscription-usage","options":{"method":"get"}},{"id":"/docs/api/merchant/2025-10-16#update-subscription-usage","title":"Update a subscription usage","use":"a","href":"#update-subscription-usage","options":{"method":"patch"}},{"id":"/docs/api/merchant/2025-10-16#delete-subscription-usage","title":"Delete a subscription usage","use":"a","href":"#delete-subscription-usage","options":{"method":"delete"}}]},{"id":"/docs/api/merchant/2025-10-16#tag-payouts","title":"Payouts","use":"a","href":"#tag-payouts","items":[{"id":"/docs/api/merchant/2025-10-16#retrieve-payout-list","title":"Retrieve a payout list","use":"a","href":"#retrieve-payout-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2025-10-16#retrieve-payout","title":"Retrieve a payout","use":"a","href":"#retrieve-payout","options":{"method":"get"}}]},{"id":"/docs/api/merchant/2025-10-16#tag-disputes","title":"Disputes","use":"a","href":"#tag-disputes","items":[{"id":"/docs/api/merchant/2025-10-16#retrieve-dispute-list","title":"Retrieve a dispute list","use":"a","href":"#retrieve-dispute-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2025-10-16#retrieve-dispute","title":"Retrieve a dispute","use":"a","href":"#retrieve-dispute","options":{"method":"get"}},{"id":"/docs/api/merchant/2025-10-16#accept-dispute","title":"Accept a dispute","use":"a","href":"#accept-dispute","options":{"method":"post"}},{"id":"/docs/api/merchant/2025-10-16#upload-dispute-evidence","title":"Upload evidence for a dispute","use":"a","href":"#upload-dispute-evidence","options":{"method":"post"}},{"id":"/docs/api/merchant/2025-10-16#challenge-dispute","title":"Challenge a dispute","use":"a","href":"#challenge-dispute","options":{"method":"post"}}]},{"id":"/docs/api/merchant/2025-10-16#tag-report-runs","title":"Report runs","use":"a","href":"#tag-report-runs","items":[{"id":"/docs/api/merchant/2025-10-16#create-report-run","title":"Create a report run","use":"a","href":"#create-report-run","options":{"method":"post"}},{"id":"/docs/api/merchant/2025-10-16#retrieve-report-run","title":"Retrieve a report run","use":"a","href":"#retrieve-report-run","options":{"method":"get"}},{"id":"/docs/api/merchant/2025-10-16#download-report-file","title":"Download report file","use":"a","href":"#download-report-file","options":{"method":"get"}}]},{"id":"/docs/api/merchant/2025-10-16#tag-webhooks","title":"Webhooks","use":"a","href":"#tag-webhooks","items":[{"id":"/docs/api/merchant/2025-10-16#create-webhook","title":"Create a webhook","use":"a","href":"#create-webhook","options":{"method":"post"}},{"id":"/docs/api/merchant/2025-10-16#retrieve-webhook-list","title":"Retrieve a webhook list","use":"a","href":"#retrieve-webhook-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2025-10-16#retrieve-webhook","title":"Retrieve a webhook","use":"a","href":"#retrieve-webhook","options":{"method":"get"}},{"id":"/docs/api/merchant/2025-10-16#update-webhook","title":"Update a webhook","use":"a","href":"#update-webhook","options":{"method":"patch"}},{"id":"/docs/api/merchant/2025-10-16#delete-webhook","title":"Delete a webhook","use":"a","href":"#delete-webhook","options":{"method":"delete"}},{"id":"/docs/api/merchant/2025-10-16#rotate-webhook-signing-secret","title":"Rotate a webhook signing secret","use":"a","href":"#rotate-webhook-signing-secret","options":{"method":"post"}},{"id":"/docs/api/merchant/2025-10-16#webhook-webhook-event","title":"Webhook event","use":"a","href":"#webhook-webhook-event","options":{"method":"webhook"}}]},{"id":"/docs/api/merchant/2025-10-16#tag-locations","title":"Locations","use":"a","href":"#tag-locations","items":[{"id":"/docs/api/merchant/2025-10-16#create-location","title":"Create a location","use":"a","href":"#create-location","options":{"method":"post"}},{"id":"/docs/api/merchant/2025-10-16#retrieve-location-list","title":"Retrieve location list","use":"a","href":"#retrieve-location-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2025-10-16#retrieve-location","title":"Retrieve a location","use":"a","href":"#retrieve-location","options":{"method":"get"}},{"id":"/docs/api/merchant/2025-10-16#update-location","title":"Update a location","use":"a","href":"#update-location","options":{"method":"patch"}},{"id":"/docs/api/merchant/2025-10-16#delete-location","title":"Delete a location","use":"a","href":"#delete-location","options":{"method":"delete"}}]},{"id":"/docs/api/merchant/2025-10-16#tag-terminals","title":"Terminals","use":"a","href":"#tag-terminals","items":[{"id":"/docs/api/merchant/2025-10-16#retrieve-terminal-list","title":"Retrieve terminal list","use":"a","href":"#retrieve-terminal-list","options":{"method":"get"}}]},{"id":"/docs/api/merchant/2025-10-16#tag-payment-intents","title":"Payment intents","use":"a","href":"#tag-payment-intents","items":[{"id":"/docs/api/merchant/2025-10-16#create-payment-intent","title":"Create a payment intent","use":"a","href":"#create-payment-intent","options":{"method":"post"}},{"id":"/docs/api/merchant/2025-10-16#retrieve-payment-intent","title":"Retrieve a payment intent","use":"a","href":"#retrieve-payment-intent","options":{"method":"get"}},{"id":"/docs/api/merchant/2025-10-16#cancel-payment-intent","title":"Cancel a payment intent","use":"a","href":"#cancel-payment-intent","options":{"method":"post"}}]},{"id":"/docs/api/merchant/2025-10-16#tag-apple-pay-merchant-registration","title":"Apple Pay merchant registration","use":"a","href":"#tag-apple-pay-merchant-registration","items":[{"id":"/docs/api/merchant/2025-10-16#register-domain-apple-pay","title":"Register domain for Apple Pay","use":"a","href":"#register-domain-apple-pay","options":{"method":"post"}},{"id":"/docs/api/merchant/2025-10-16#unregister-domain-apple-pay","title":"Unregister domain for Apple Pay","use":"a","href":"#unregister-domain-apple-pay","options":{"method":"post"}}]},{"id":"/docs/api/merchant/2025-10-16#tag-other","title":"Other","use":"a","href":"#tag-other","items":[{"id":"/docs/api/merchant/2025-10-16#register-address-validation-endpoint","title":"Register address validation endpoint for Fast checkout","use":"a","href":"#register-address-validation-endpoint","options":{"method":"post"}},{"id":"/docs/api/merchant/2025-10-16#retrieve-synchronous-webhook-list","title":"Retrieve a synchronous webhook list","use":"a","href":"#retrieve-synchronous-webhook-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2025-10-16#delete-synchronous-webhook","title":"Delete a synchronous webhook","use":"a","href":"#delete-synchronous-webhook","options":{"method":"delete"}}]}],"versions":[{"label":"2026-08-17","path":"/docs/api/merchant","latest":true},{"label":"2026-04-20","path":"/docs/api/merchant/2026-04-20","latest":false},{"label":"2026-03-12","path":"/docs/api/merchant/2026-03-12","latest":false},{"label":"2025-12-04","path":"/docs/api/merchant/2025-12-04","latest":false},{"label":"2025-10-16","path":"/docs/api/merchant/2025-10-16","latest":false},{"label":"2024-09-01","path":"/docs/api/merchant/2024-09-01","latest":false},{"label":"2024-05-01","path":"/docs/api/merchant/2024-05-01","latest":false},{"label":"2023-09-01","path":"/docs/api/merchant/2023-09-01","latest":false},{"label":"Legacy","path":"/docs/api/merchant/Legacy","latest":false}]},"/docs/api/merchant/2024-09-01":{"items":[{"id":"/docs/api/merchant/2024-09-01#tag-orders","title":"Orders","use":"a","href":"#tag-orders","items":[{"id":"/docs/api/merchant/2024-09-01#create-order","title":"Create an order","use":"a","href":"#create-order","options":{"method":"post"}},{"id":"/docs/api/merchant/2024-09-01#retrieve-order-list","title":"Retrieve an order list","use":"a","href":"#retrieve-order-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2024-09-01#retrieve-order","title":"Retrieve an order","use":"a","href":"#retrieve-order","options":{"method":"get"}},{"id":"/docs/api/merchant/2024-09-01#update-order","title":"Update an order","use":"a","href":"#update-order","options":{"method":"patch"}},{"id":"/docs/api/merchant/2024-09-01#increment-order-authorisation","title":"Increment authorisation","use":"a","href":"#increment-order-authorisation","options":{"method":"post"}},{"id":"/docs/api/merchant/2024-09-01#capture-order","title":"Capture an order","use":"a","href":"#capture-order","options":{"method":"post"}},{"id":"/docs/api/merchant/2024-09-01#cancel-order","title":"Cancel an order","use":"a","href":"#cancel-order","options":{"method":"post"}},{"id":"/docs/api/merchant/2024-09-01#refund-order","title":"Refund an order","use":"a","href":"#refund-order","options":{"method":"post"}},{"id":"/docs/api/merchant/2024-09-01#pay-order","title":"Pay for an order","use":"a","href":"#pay-order","options":{"method":"post"}},{"id":"/docs/api/merchant/2024-09-01#retrieve-payment-list","title":"Retrieve payment list of an order","use":"a","href":"#retrieve-payment-list","options":{"method":"get"}}]},{"id":"/docs/api/merchant/2024-09-01#tag-customers","title":"Customers","use":"a","href":"#tag-customers","items":[{"id":"/docs/api/merchant/2024-09-01#create-customer","title":"Create a customer","use":"a","href":"#create-customer","options":{"method":"post"}},{"id":"/docs/api/merchant/2024-09-01#retrieve-customer-list","title":"Retrieve a customer list","use":"a","href":"#retrieve-customer-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2024-09-01#retrieve-customer","title":"Retrieve a customer","use":"a","href":"#retrieve-customer","options":{"method":"get"}},{"id":"/docs/api/merchant/2024-09-01#update-customer","title":"Update a customer","use":"a","href":"#update-customer","options":{"method":"patch"}},{"id":"/docs/api/merchant/2024-09-01#delete-customer","title":"Delete a customer","use":"a","href":"#delete-customer","options":{"method":"delete"}},{"id":"/docs/api/merchant/2024-09-01#retrieve-payment-method-list","title":"Retrieve payment method list of a customer","use":"a","href":"#retrieve-payment-method-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2024-09-01#retrieve-payment-method","title":"Retrieve a customer's payment method","use":"a","href":"#retrieve-payment-method","options":{"method":"get"}},{"id":"/docs/api/merchant/2024-09-01#update-payment-method","title":"Update a customer's payment method","use":"a","href":"#update-payment-method","options":{"method":"patch"}},{"id":"/docs/api/merchant/2024-09-01#delete-payment-method","title":"Delete a customer's payment method","use":"a","href":"#delete-payment-method","options":{"method":"delete"}}]},{"id":"/docs/api/merchant/2024-09-01#tag-payments","title":"Payments","use":"a","href":"#tag-payments","items":[{"id":"/docs/api/merchant/2024-09-01#retrieve-payment-details","title":"Retrieve payment details","use":"a","href":"#retrieve-payment-details","options":{"method":"get"}}]},{"id":"/docs/api/merchant/2024-09-01#tag-subscriptions","title":"Subscriptions","use":"a","href":"#tag-subscriptions","items":[{"id":"/docs/api/merchant/2024-09-01#create-subscription-plan","title":"Create a subscription plan","use":"a","href":"#create-subscription-plan","options":{"method":"post"}},{"id":"/docs/api/merchant/2024-09-01#retrieve-subscription-plan-list","title":"Retrieve a subscription plan list","use":"a","href":"#retrieve-subscription-plan-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2024-09-01#retrieve-subscription-plan","title":"Retrieve a subscription plan","use":"a","href":"#retrieve-subscription-plan","options":{"method":"get"}},{"id":"/docs/api/merchant/2024-09-01#create-subscription","title":"Create a subscription","use":"a","href":"#create-subscription","options":{"method":"post"}},{"id":"/docs/api/merchant/2024-09-01#retrieve-subscription-list","title":"Retrieve a subscription list","use":"a","href":"#retrieve-subscription-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2024-09-01#retrieve-subscription","title":"Retrieve a subscription","use":"a","href":"#retrieve-subscription","options":{"method":"get"}},{"id":"/docs/api/merchant/2024-09-01#update-subscription","title":"Update a subscription","use":"a","href":"#update-subscription","options":{"method":"patch"}},{"id":"/docs/api/merchant/2024-09-01#cancel-subscription","title":"Cancel a subscription","use":"a","href":"#cancel-subscription","options":{"method":"post"}},{"id":"/docs/api/merchant/2024-09-01#change-subscription-plan","title":"Change a subscription plan","use":"a","href":"#change-subscription-plan","options":{"method":"post"}},{"id":"/docs/api/merchant/2024-09-01#update-subscription-renewal-date","title":"Update a subscription renewal date","use":"a","href":"#update-subscription-renewal-date","options":{"method":"post"}},{"id":"/docs/api/merchant/2024-09-01#retrieve-subscription-cycle-list","title":"Retrieve a subscription cycle list","use":"a","href":"#retrieve-subscription-cycle-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2024-09-01#retrieve-subscription-cycle","title":"Retrieve a subscription cycle","use":"a","href":"#retrieve-subscription-cycle","options":{"method":"get"}},{"id":"/docs/api/merchant/2024-09-01#create-subscription-usage","title":"Create a subscription usage","use":"a","href":"#create-subscription-usage","options":{"method":"post"}},{"id":"/docs/api/merchant/2024-09-01#retrieve-subscription-usage-list","title":"Retrieve a subscription usage list","use":"a","href":"#retrieve-subscription-usage-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2024-09-01#retrieve-subscription-usage","title":"Retrieve a subscription usage","use":"a","href":"#retrieve-subscription-usage","options":{"method":"get"}},{"id":"/docs/api/merchant/2024-09-01#update-subscription-usage","title":"Update a subscription usage","use":"a","href":"#update-subscription-usage","options":{"method":"patch"}},{"id":"/docs/api/merchant/2024-09-01#delete-subscription-usage","title":"Delete a subscription usage","use":"a","href":"#delete-subscription-usage","options":{"method":"delete"}}]},{"id":"/docs/api/merchant/2024-09-01#tag-payouts","title":"Payouts","use":"a","href":"#tag-payouts","items":[{"id":"/docs/api/merchant/2024-09-01#retrieve-payout-list","title":"Retrieve a payout list","use":"a","href":"#retrieve-payout-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2024-09-01#retrieve-payout","title":"Retrieve a payout","use":"a","href":"#retrieve-payout","options":{"method":"get"}}]},{"id":"/docs/api/merchant/2024-09-01#tag-disputes","title":"Disputes","use":"a","href":"#tag-disputes","items":[{"id":"/docs/api/merchant/2024-09-01#retrieve-dispute-list","title":"Retrieve a dispute list","use":"a","href":"#retrieve-dispute-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2024-09-01#retrieve-dispute","title":"Retrieve a dispute","use":"a","href":"#retrieve-dispute","options":{"method":"get"}},{"id":"/docs/api/merchant/2024-09-01#accept-dispute","title":"Accept a dispute","use":"a","href":"#accept-dispute","options":{"method":"post"}},{"id":"/docs/api/merchant/2024-09-01#upload-dispute-evidence","title":"Upload evidence for a dispute","use":"a","href":"#upload-dispute-evidence","options":{"method":"post"}},{"id":"/docs/api/merchant/2024-09-01#challenge-dispute","title":"Challenge a dispute","use":"a","href":"#challenge-dispute","options":{"method":"post"}}]},{"id":"/docs/api/merchant/2024-09-01#tag-report-runs","title":"Report runs","use":"a","href":"#tag-report-runs","items":[{"id":"/docs/api/merchant/2024-09-01#create-report-run","title":"Create a report run","use":"a","href":"#create-report-run","options":{"method":"post"}},{"id":"/docs/api/merchant/2024-09-01#retrieve-report-run","title":"Retrieve a report run","use":"a","href":"#retrieve-report-run","options":{"method":"get"}},{"id":"/docs/api/merchant/2024-09-01#download-report-file","title":"Download report file","use":"a","href":"#download-report-file","options":{"method":"get"}}]},{"id":"/docs/api/merchant/2024-09-01#tag-webhooks","title":"Webhooks","use":"a","href":"#tag-webhooks","items":[{"id":"/docs/api/merchant/2024-09-01#create-webhook","title":"Create a webhook","use":"a","href":"#create-webhook","options":{"method":"post"}},{"id":"/docs/api/merchant/2024-09-01#retrieve-webhook-list","title":"Retrieve a webhook list","use":"a","href":"#retrieve-webhook-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2024-09-01#retrieve-webhook","title":"Retrieve a webhook","use":"a","href":"#retrieve-webhook","options":{"method":"get"}},{"id":"/docs/api/merchant/2024-09-01#update-webhook","title":"Update a webhook","use":"a","href":"#update-webhook","options":{"method":"patch"}},{"id":"/docs/api/merchant/2024-09-01#delete-webhook","title":"Delete a webhook","use":"a","href":"#delete-webhook","options":{"method":"delete"}},{"id":"/docs/api/merchant/2024-09-01#rotate-webhook-signing-secret","title":"Rotate a webhook signing secret","use":"a","href":"#rotate-webhook-signing-secret","options":{"method":"post"}},{"id":"/docs/api/merchant/2024-09-01#webhook-webhook-event","title":"Webhook event","use":"a","href":"#webhook-webhook-event","options":{"method":"webhook"}}]},{"id":"/docs/api/merchant/2024-09-01#tag-locations","title":"Locations","use":"a","href":"#tag-locations","items":[{"id":"/docs/api/merchant/2024-09-01#create-location","title":"Create a location","use":"a","href":"#create-location","options":{"method":"post"}},{"id":"/docs/api/merchant/2024-09-01#retrieve-location-list","title":"Retrieve location list","use":"a","href":"#retrieve-location-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2024-09-01#retrieve-location","title":"Retrieve a location","use":"a","href":"#retrieve-location","options":{"method":"get"}},{"id":"/docs/api/merchant/2024-09-01#update-location","title":"Update a location","use":"a","href":"#update-location","options":{"method":"patch"}},{"id":"/docs/api/merchant/2024-09-01#delete-location","title":"Delete a location","use":"a","href":"#delete-location","options":{"method":"delete"}}]},{"id":"/docs/api/merchant/2024-09-01#tag-terminals","title":"Terminals","use":"a","href":"#tag-terminals","items":[{"id":"/docs/api/merchant/2024-09-01#retrieve-terminal-list","title":"Retrieve terminal list","use":"a","href":"#retrieve-terminal-list","options":{"method":"get"}}]},{"id":"/docs/api/merchant/2024-09-01#tag-payment-intents","title":"Payment intents","use":"a","href":"#tag-payment-intents","items":[{"id":"/docs/api/merchant/2024-09-01#create-payment-intent","title":"Create a payment intent","use":"a","href":"#create-payment-intent","options":{"method":"post"}},{"id":"/docs/api/merchant/2024-09-01#retrieve-payment-intent","title":"Retrieve a payment intent","use":"a","href":"#retrieve-payment-intent","options":{"method":"get"}},{"id":"/docs/api/merchant/2024-09-01#cancel-payment-intent","title":"Cancel a payment intent","use":"a","href":"#cancel-payment-intent","options":{"method":"post"}}]},{"id":"/docs/api/merchant/2024-09-01#tag-apple-pay-merchant-registration","title":"Apple Pay merchant registration","use":"a","href":"#tag-apple-pay-merchant-registration","items":[{"id":"/docs/api/merchant/2024-09-01#register-domain-apple-pay","title":"Register domain for Apple Pay","use":"a","href":"#register-domain-apple-pay","options":{"method":"post"}},{"id":"/docs/api/merchant/2024-09-01#unregister-domain-apple-pay","title":"Unregister domain for Apple Pay","use":"a","href":"#unregister-domain-apple-pay","options":{"method":"post"}}]},{"id":"/docs/api/merchant/2024-09-01#tag-other","title":"Other","use":"a","href":"#tag-other","items":[{"id":"/docs/api/merchant/2024-09-01#register-address-validation-endpoint","title":"Register address validation endpoint for Fast checkout","use":"a","href":"#register-address-validation-endpoint","options":{"method":"post"}},{"id":"/docs/api/merchant/2024-09-01#retrieve-synchronous-webhook-list","title":"Retrieve a synchronous webhook list","use":"a","href":"#retrieve-synchronous-webhook-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2024-09-01#delete-synchronous-webhook","title":"Delete a synchronous webhook","use":"a","href":"#delete-synchronous-webhook","options":{"method":"delete"}}]}],"versions":[{"label":"2026-08-17","path":"/docs/api/merchant","latest":true},{"label":"2026-04-20","path":"/docs/api/merchant/2026-04-20","latest":false},{"label":"2026-03-12","path":"/docs/api/merchant/2026-03-12","latest":false},{"label":"2025-12-04","path":"/docs/api/merchant/2025-12-04","latest":false},{"label":"2025-10-16","path":"/docs/api/merchant/2025-10-16","latest":false},{"label":"2024-09-01","path":"/docs/api/merchant/2024-09-01","latest":false},{"label":"2024-05-01","path":"/docs/api/merchant/2024-05-01","latest":false},{"label":"2023-09-01","path":"/docs/api/merchant/2023-09-01","latest":false},{"label":"Legacy","path":"/docs/api/merchant/Legacy","latest":false}]},"/docs/api/merchant/2024-05-01":{"items":[{"id":"/docs/api/merchant/2024-05-01#tag-orders","title":"Orders","use":"a","href":"#tag-orders","items":[{"id":"/docs/api/merchant/2024-05-01#create-order","title":"Create an order","use":"a","href":"#create-order","options":{"method":"post"}},{"id":"/docs/api/merchant/2024-05-01#retrieve-order","title":"Retrieve an order","use":"a","href":"#retrieve-order","options":{"method":"get"}},{"id":"/docs/api/merchant/2024-05-01#update-order","title":"Update an order","use":"a","href":"#update-order","options":{"method":"patch"}},{"id":"/docs/api/merchant/2024-05-01#retrieve-order-list","title":"Retrieve an order list","use":"a","href":"#retrieve-order-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2024-05-01#increment-order-authorisation","title":"Increment authorisation","use":"a","href":"#increment-order-authorisation","options":{"method":"post"}},{"id":"/docs/api/merchant/2024-05-01#capture-order","title":"Capture an order","use":"a","href":"#capture-order","options":{"method":"post"}},{"id":"/docs/api/merchant/2024-05-01#cancel-order","title":"Cancel an order","use":"a","href":"#cancel-order","options":{"method":"post"}},{"id":"/docs/api/merchant/2024-05-01#refund-order-deprecated","title":"Refund an order (Deprecated)","use":"a","href":"#refund-order-deprecated","options":{"method":"post"}},{"id":"/docs/api/merchant/2024-05-01#pay-order","title":"Pay for an order","use":"a","href":"#pay-order","options":{"method":"post"}},{"id":"/docs/api/merchant/2024-05-01#retrieve-payment-list","title":"Retrieve payment list of an order","use":"a","href":"#retrieve-payment-list","options":{"method":"get"}}]},{"id":"/docs/api/merchant/2024-05-01#tag-customers","title":"Customers","use":"a","href":"#tag-customers","items":[{"id":"/docs/api/merchant/2024-05-01#create-customer-deprecated","title":"Create a customer (Deprecated)","use":"a","href":"#create-customer-deprecated","options":{"method":"post"}},{"id":"/docs/api/merchant/2024-05-01#retrieve-all-customers-deprecated","title":"Retrieve a customer list (Deprecated)","use":"a","href":"#retrieve-all-customers-deprecated","options":{"method":"get"}},{"id":"/docs/api/merchant/2024-05-01#retrieve-customer-deprecated","title":"Retrieve a customer (Deprecated)","use":"a","href":"#retrieve-customer-deprecated","options":{"method":"get"}},{"id":"/docs/api/merchant/2024-05-01#update-customer-deprecated","title":"Update a customer (Deprecated)","use":"a","href":"#update-customer-deprecated","options":{"method":"patch"}},{"id":"/docs/api/merchant/2024-05-01#delete-customer-deprecated","title":"Delete a customer (Deprecated)","use":"a","href":"#delete-customer-deprecated","options":{"method":"delete"}},{"id":"/docs/api/merchant/2024-05-01#retrieve-all-payment-methods-deprecated","title":"Retrieve all payment methods of a customer (Deprecated)","use":"a","href":"#retrieve-all-payment-methods-deprecated","options":{"method":"get"}},{"id":"/docs/api/merchant/2024-05-01#retrieve-payment-method-deprecated","title":"Retrieve a customer's payment method (Deprecated)","use":"a","href":"#retrieve-payment-method-deprecated","options":{"method":"get"}},{"id":"/docs/api/merchant/2024-05-01#update-payment-method-deprecated","title":"Update a customer's payment method (Deprecated)","use":"a","href":"#update-payment-method-deprecated","options":{"method":"patch"}},{"id":"/docs/api/merchant/2024-05-01#delete-payment-method-deprecated","title":"Delete a customer's payment method (Deprecated)","use":"a","href":"#delete-payment-method-deprecated","options":{"method":"delete"}}]},{"id":"/docs/api/merchant/2024-05-01#tag-payments","title":"Payments","use":"a","href":"#tag-payments","items":[{"id":"/docs/api/merchant/2024-05-01#retrieve-payment-details","title":"Retrieve payment details","use":"a","href":"#retrieve-payment-details","options":{"method":"get"}}]},{"id":"/docs/api/merchant/2024-05-01#tag-payouts","title":"Payouts","use":"a","href":"#tag-payouts","items":[{"id":"/docs/api/merchant/2024-05-01#retrieve-payout-list","title":"Retrieve a payout list","use":"a","href":"#retrieve-payout-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2024-05-01#retrieve-payout","title":"Retrieve a payout","use":"a","href":"#retrieve-payout","options":{"method":"get"}}]},{"id":"/docs/api/merchant/2024-05-01#tag-report-runs","title":"Report runs","use":"a","href":"#tag-report-runs","items":[{"id":"/docs/api/merchant/2024-05-01#create-report-run","title":"Create a report run","use":"a","href":"#create-report-run","options":{"method":"post"}},{"id":"/docs/api/merchant/2024-05-01#retrieve-report-run","title":"Retrieve a report run","use":"a","href":"#retrieve-report-run","options":{"method":"get"}},{"id":"/docs/api/merchant/2024-05-01#download-report-file","title":"Download report file","use":"a","href":"#download-report-file","options":{"method":"get"}}]},{"id":"/docs/api/merchant/2024-05-01#tag-webhooks","title":"Webhooks","use":"a","href":"#tag-webhooks","items":[{"id":"/docs/api/merchant/2024-05-01#create-webhook-deprecated","title":"Create a webhook (Deprecated)","use":"a","href":"#create-webhook-deprecated","options":{"method":"post"}},{"id":"/docs/api/merchant/2024-05-01#retrieve-all-webhooks-deprecated","title":"Retrieve a webhook list (Deprecated)","use":"a","href":"#retrieve-all-webhooks-deprecated","options":{"method":"get"}},{"id":"/docs/api/merchant/2024-05-01#retrieve-webhook-deprecated","title":"Retrieve a webhook (Deprecated)","use":"a","href":"#retrieve-webhook-deprecated","options":{"method":"get"}},{"id":"/docs/api/merchant/2024-05-01#update-webhook-deprecated","title":"Update a webhook (Deprecated)","use":"a","href":"#update-webhook-deprecated","options":{"method":"put"}},{"id":"/docs/api/merchant/2024-05-01#delete-webhook-deprecated","title":"Delete a webhook (Deprecated)","use":"a","href":"#delete-webhook-deprecated","options":{"method":"delete"}},{"id":"/docs/api/merchant/2024-05-01#rotate-webhook-signing-secret-deprecated","title":"Rotate a webhook signing secret (Deprecated)","use":"a","href":"#rotate-webhook-signing-secret-deprecated","options":{"method":"post"}},{"id":"/docs/api/merchant/2024-05-01#webhook-webhook-event","title":"Webhook event","use":"a","href":"#webhook-webhook-event","options":{"method":"webhook"}}]},{"id":"/docs/api/merchant/2024-05-01#tag-locations","title":"Locations","use":"a","href":"#tag-locations","items":[{"id":"/docs/api/merchant/2024-05-01#create-location","title":"Create a location","use":"a","href":"#create-location","options":{"method":"post"}},{"id":"/docs/api/merchant/2024-05-01#retrieve-location-list","title":"Retrieve location list","use":"a","href":"#retrieve-location-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2024-05-01#retrieve-location","title":"Retrieve a location","use":"a","href":"#retrieve-location","options":{"method":"get"}},{"id":"/docs/api/merchant/2024-05-01#update-location","title":"Update a location","use":"a","href":"#update-location","options":{"method":"patch"}},{"id":"/docs/api/merchant/2024-05-01#delete-location","title":"Delete a location","use":"a","href":"#delete-location","options":{"method":"delete"}}]},{"id":"/docs/api/merchant/2024-05-01#tag-terminals","title":"Terminals","use":"a","href":"#tag-terminals","items":[{"id":"/docs/api/merchant/2024-05-01#retrieve-terminal-list","title":"Retrieve terminal list","use":"a","href":"#retrieve-terminal-list","options":{"method":"get"}}]},{"id":"/docs/api/merchant/2024-05-01#tag-payment-intents","title":"Payment intents","use":"a","href":"#tag-payment-intents","items":[{"id":"/docs/api/merchant/2024-05-01#create-payment-intent","title":"Create a payment intent","use":"a","href":"#create-payment-intent","options":{"method":"post"}},{"id":"/docs/api/merchant/2024-05-01#retrieve-payment-intent","title":"Retrieve a payment intent","use":"a","href":"#retrieve-payment-intent","options":{"method":"get"}},{"id":"/docs/api/merchant/2024-05-01#cancel-payment-intent","title":"Cancel a payment intent","use":"a","href":"#cancel-payment-intent","options":{"method":"post"}}]},{"id":"/docs/api/merchant/2024-05-01#tag-apple-pay-merchant-registration","title":"Apple Pay merchant registration","use":"a","href":"#tag-apple-pay-merchant-registration","items":[{"id":"/docs/api/merchant/2024-05-01#register-domain-apple-pay","title":"Register domain for Apple Pay","use":"a","href":"#register-domain-apple-pay","options":{"method":"post"}},{"id":"/docs/api/merchant/2024-05-01#unregister-domain-apple-pay","title":"Unregister domain for Apple Pay","use":"a","href":"#unregister-domain-apple-pay","options":{"method":"post"}}]},{"id":"/docs/api/merchant/2024-05-01#tag-other","title":"Other","use":"a","href":"#tag-other","items":[{"id":"/docs/api/merchant/2024-05-01#register-address-validation-endpoint","title":"Register address validation endpoint for Fast checkout","use":"a","href":"#register-address-validation-endpoint","options":{"method":"post"}},{"id":"/docs/api/merchant/2024-05-01#retrieve-synchronous-webhook-list","title":"Retrieve a synchronous webhook list","use":"a","href":"#retrieve-synchronous-webhook-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2024-05-01#delete-synchronous-webhook","title":"Delete a synchronous webhook","use":"a","href":"#delete-synchronous-webhook","options":{"method":"delete"}}]}],"versions":[{"label":"2026-08-17","path":"/docs/api/merchant","latest":true},{"label":"2026-04-20","path":"/docs/api/merchant/2026-04-20","latest":false},{"label":"2026-03-12","path":"/docs/api/merchant/2026-03-12","latest":false},{"label":"2025-12-04","path":"/docs/api/merchant/2025-12-04","latest":false},{"label":"2025-10-16","path":"/docs/api/merchant/2025-10-16","latest":false},{"label":"2024-09-01","path":"/docs/api/merchant/2024-09-01","latest":false},{"label":"2024-05-01","path":"/docs/api/merchant/2024-05-01","latest":false},{"label":"2023-09-01","path":"/docs/api/merchant/2023-09-01","latest":false},{"label":"Legacy","path":"/docs/api/merchant/Legacy","latest":false}]},"/docs/api/merchant/2023-09-01":{"items":[{"id":"/docs/api/merchant/2023-09-01#tag-orders","title":"Orders","use":"a","href":"#tag-orders","items":[{"id":"/docs/api/merchant/2023-09-01#create-order","title":"Create an order","use":"a","href":"#create-order","options":{"method":"post"}},{"id":"/docs/api/merchant/2023-09-01#retrieve-order","title":"Retrieve an order","use":"a","href":"#retrieve-order","options":{"method":"get"}},{"id":"/docs/api/merchant/2023-09-01#update-order","title":"Update an order","use":"a","href":"#update-order","options":{"method":"patch"}},{"id":"/docs/api/merchant/2023-09-01#retrieve-order-list","title":"Retrieve an order list","use":"a","href":"#retrieve-order-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2023-09-01#capture-order","title":"Capture an order","use":"a","href":"#capture-order","options":{"method":"post"}},{"id":"/docs/api/merchant/2023-09-01#cancel-order","title":"Cancel an order","use":"a","href":"#cancel-order","options":{"method":"post"}},{"id":"/docs/api/merchant/2023-09-01#refund-order-deprecated","title":"Refund an order (Deprecated)","use":"a","href":"#refund-order-deprecated","options":{"method":"post"}},{"id":"/docs/api/merchant/2023-09-01#pay-order","title":"Pay for an order","use":"a","href":"#pay-order","options":{"method":"post"}},{"id":"/docs/api/merchant/2023-09-01#retrieve-payment-list","title":"Retrieve payment list of an order","use":"a","href":"#retrieve-payment-list","options":{"method":"get"}}]},{"id":"/docs/api/merchant/2023-09-01#tag-customers","title":"Customers","use":"a","href":"#tag-customers","items":[{"id":"/docs/api/merchant/2023-09-01#create-customer-deprecated","title":"Create a customer (Deprecated)","use":"a","href":"#create-customer-deprecated","options":{"method":"post"}},{"id":"/docs/api/merchant/2023-09-01#retrieve-all-customers-deprecated","title":"Retrieve a customer list (Deprecated)","use":"a","href":"#retrieve-all-customers-deprecated","options":{"method":"get"}},{"id":"/docs/api/merchant/2023-09-01#retrieve-customer-deprecated","title":"Retrieve a customer (Deprecated)","use":"a","href":"#retrieve-customer-deprecated","options":{"method":"get"}},{"id":"/docs/api/merchant/2023-09-01#update-customer-deprecated","title":"Update a customer (Deprecated)","use":"a","href":"#update-customer-deprecated","options":{"method":"patch"}},{"id":"/docs/api/merchant/2023-09-01#delete-customer-deprecated","title":"Delete a customer (Deprecated)","use":"a","href":"#delete-customer-deprecated","options":{"method":"delete"}},{"id":"/docs/api/merchant/2023-09-01#retrieve-all-payment-methods-deprecated","title":"Retrieve all payment methods of a customer (Deprecated)","use":"a","href":"#retrieve-all-payment-methods-deprecated","options":{"method":"get"}},{"id":"/docs/api/merchant/2023-09-01#retrieve-payment-method-deprecated","title":"Retrieve a customer's payment method (Deprecated)","use":"a","href":"#retrieve-payment-method-deprecated","options":{"method":"get"}},{"id":"/docs/api/merchant/2023-09-01#update-payment-method-deprecated","title":"Update a customer's payment method (Deprecated)","use":"a","href":"#update-payment-method-deprecated","options":{"method":"patch"}},{"id":"/docs/api/merchant/2023-09-01#delete-payment-method-deprecated","title":"Delete a customer's payment method (Deprecated)","use":"a","href":"#delete-payment-method-deprecated","options":{"method":"delete"}}]},{"id":"/docs/api/merchant/2023-09-01#tag-payments","title":"Payments","use":"a","href":"#tag-payments","items":[{"id":"/docs/api/merchant/2023-09-01#retrieve-payment-details","title":"Retrieve payment details","use":"a","href":"#retrieve-payment-details","options":{"method":"get"}}]},{"id":"/docs/api/merchant/2023-09-01#tag-payouts","title":"Payouts","use":"a","href":"#tag-payouts","items":[{"id":"/docs/api/merchant/2023-09-01#retrieve-payout-list","title":"Retrieve a payout list","use":"a","href":"#retrieve-payout-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2023-09-01#retrieve-payout","title":"Retrieve a payout","use":"a","href":"#retrieve-payout","options":{"method":"get"}}]},{"id":"/docs/api/merchant/2023-09-01#tag-report-runs","title":"Report runs","use":"a","href":"#tag-report-runs","items":[{"id":"/docs/api/merchant/2023-09-01#create-report-run","title":"Create a report run","use":"a","href":"#create-report-run","options":{"method":"post"}},{"id":"/docs/api/merchant/2023-09-01#retrieve-report-run","title":"Retrieve a report run","use":"a","href":"#retrieve-report-run","options":{"method":"get"}},{"id":"/docs/api/merchant/2023-09-01#download-report-file","title":"Download report file","use":"a","href":"#download-report-file","options":{"method":"get"}}]},{"id":"/docs/api/merchant/2023-09-01#tag-webhooks","title":"Webhooks","use":"a","href":"#tag-webhooks","items":[{"id":"/docs/api/merchant/2023-09-01#create-webhook-deprecated","title":"Create a webhook (Deprecated)","use":"a","href":"#create-webhook-deprecated","options":{"method":"post"}},{"id":"/docs/api/merchant/2023-09-01#retrieve-all-webhooks-deprecated","title":"Retrieve a webhook list (Deprecated)","use":"a","href":"#retrieve-all-webhooks-deprecated","options":{"method":"get"}},{"id":"/docs/api/merchant/2023-09-01#retrieve-webhook-deprecated","title":"Retrieve a webhook (Deprecated)","use":"a","href":"#retrieve-webhook-deprecated","options":{"method":"get"}},{"id":"/docs/api/merchant/2023-09-01#update-webhook-deprecated","title":"Update a webhook (Deprecated)","use":"a","href":"#update-webhook-deprecated","options":{"method":"put"}},{"id":"/docs/api/merchant/2023-09-01#delete-webhook-deprecated","title":"Delete a webhook (Deprecated)","use":"a","href":"#delete-webhook-deprecated","options":{"method":"delete"}},{"id":"/docs/api/merchant/2023-09-01#rotate-webhook-signing-secret-deprecated","title":"Rotate a webhook signing secret (Deprecated)","use":"a","href":"#rotate-webhook-signing-secret-deprecated","options":{"method":"post"}},{"id":"/docs/api/merchant/2023-09-01#webhook-webhook-event","title":"Webhook event","use":"a","href":"#webhook-webhook-event","options":{"method":"webhook"}}]},{"id":"/docs/api/merchant/2023-09-01#tag-locations","title":"Locations","use":"a","href":"#tag-locations","items":[{"id":"/docs/api/merchant/2023-09-01#create-location","title":"Create a location","use":"a","href":"#create-location","options":{"method":"post"}},{"id":"/docs/api/merchant/2023-09-01#retrieve-location-list","title":"Retrieve location list","use":"a","href":"#retrieve-location-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2023-09-01#retrieve-location","title":"Retrieve a location","use":"a","href":"#retrieve-location","options":{"method":"get"}},{"id":"/docs/api/merchant/2023-09-01#update-location","title":"Update a location","use":"a","href":"#update-location","options":{"method":"patch"}},{"id":"/docs/api/merchant/2023-09-01#delete-location","title":"Delete a location","use":"a","href":"#delete-location","options":{"method":"delete"}}]},{"id":"/docs/api/merchant/2023-09-01#tag-terminals","title":"Terminals","use":"a","href":"#tag-terminals","items":[{"id":"/docs/api/merchant/2023-09-01#retrieve-terminal-list","title":"Retrieve terminal list","use":"a","href":"#retrieve-terminal-list","options":{"method":"get"}}]},{"id":"/docs/api/merchant/2023-09-01#tag-payment-intents","title":"Payment intents","use":"a","href":"#tag-payment-intents","items":[{"id":"/docs/api/merchant/2023-09-01#create-payment-intent","title":"Create a payment intent","use":"a","href":"#create-payment-intent","options":{"method":"post"}},{"id":"/docs/api/merchant/2023-09-01#retrieve-payment-intent","title":"Retrieve a payment intent","use":"a","href":"#retrieve-payment-intent","options":{"method":"get"}},{"id":"/docs/api/merchant/2023-09-01#cancel-payment-intent","title":"Cancel a payment intent","use":"a","href":"#cancel-payment-intent","options":{"method":"post"}}]},{"id":"/docs/api/merchant/2023-09-01#tag-apple-pay-merchant-registration","title":"Apple Pay merchant registration","use":"a","href":"#tag-apple-pay-merchant-registration","items":[{"id":"/docs/api/merchant/2023-09-01#register-domain-apple-pay","title":"Register domain for Apple Pay","use":"a","href":"#register-domain-apple-pay","options":{"method":"post"}},{"id":"/docs/api/merchant/2023-09-01#unregister-domain-apple-pay","title":"Unregister domain for Apple Pay","use":"a","href":"#unregister-domain-apple-pay","options":{"method":"post"}}]},{"id":"/docs/api/merchant/2023-09-01#tag-other","title":"Other","use":"a","href":"#tag-other","items":[{"id":"/docs/api/merchant/2023-09-01#register-address-validation-endpoint","title":"Register address validation endpoint for Fast checkout","use":"a","href":"#register-address-validation-endpoint","options":{"method":"post"}},{"id":"/docs/api/merchant/2023-09-01#retrieve-synchronous-webhook-list","title":"Retrieve a synchronous webhook list","use":"a","href":"#retrieve-synchronous-webhook-list","options":{"method":"get"}},{"id":"/docs/api/merchant/2023-09-01#delete-synchronous-webhook","title":"Delete a synchronous webhook","use":"a","href":"#delete-synchronous-webhook","options":{"method":"delete"}}]}],"versions":[{"label":"2026-08-17","path":"/docs/api/merchant","latest":true},{"label":"2026-04-20","path":"/docs/api/merchant/2026-04-20","latest":false},{"label":"2026-03-12","path":"/docs/api/merchant/2026-03-12","latest":false},{"label":"2025-12-04","path":"/docs/api/merchant/2025-12-04","latest":false},{"label":"2025-10-16","path":"/docs/api/merchant/2025-10-16","latest":false},{"label":"2024-09-01","path":"/docs/api/merchant/2024-09-01","latest":false},{"label":"2024-05-01","path":"/docs/api/merchant/2024-05-01","latest":false},{"label":"2023-09-01","path":"/docs/api/merchant/2023-09-01","latest":false},{"label":"Legacy","path":"/docs/api/merchant/Legacy","latest":false}]},"/docs/api/merchant/Legacy":{"items":[{"id":"/docs/api/merchant/Legacy#tag-orders","title":"Orders","use":"a","href":"#tag-orders","items":[{"id":"/docs/api/merchant/Legacy#create-order-deprecated","title":"Create an order (Deprecated)","use":"a","href":"#create-order-deprecated","options":{"method":"post"}},{"id":"/docs/api/merchant/Legacy#retrieve-order-list-deprecated","title":"Retrieve an order list (Deprecated)","use":"a","href":"#retrieve-order-list-deprecated","options":{"method":"get"}},{"id":"/docs/api/merchant/Legacy#retrieve-order-deprecated","title":"Retrieve an order (Deprecated)","use":"a","href":"#retrieve-order-deprecated","options":{"method":"get"}},{"id":"/docs/api/merchant/Legacy#update-order-deprecated","title":"Update an order (Deprecated)","use":"a","href":"#update-order-deprecated","options":{"method":"patch"}},{"id":"/docs/api/merchant/Legacy#capture-order-deprecated","title":"Capture an order (Deprecated)","use":"a","href":"#capture-order-deprecated","options":{"method":"post"}},{"id":"/docs/api/merchant/Legacy#cancel-order-deprecated","title":"Cancel an order (Deprecated)","use":"a","href":"#cancel-order-deprecated","options":{"method":"post"}},{"id":"/docs/api/merchant/Legacy#refund-order-deprecated","title":"Refund an order (Deprecated)","use":"a","href":"#refund-order-deprecated","options":{"method":"post"}},{"id":"/docs/api/merchant/Legacy#pay-order","title":"Pay for an order","use":"a","href":"#pay-order","options":{"method":"post"}},{"id":"/docs/api/merchant/Legacy#retrieve-payment-list","title":"Retrieve payment list of an order","use":"a","href":"#retrieve-payment-list","options":{"method":"get"}}]},{"id":"/docs/api/merchant/Legacy#tag-customers","title":"Customers","use":"a","href":"#tag-customers","items":[{"id":"/docs/api/merchant/Legacy#create-customer-deprecated","title":"Create a customer (Deprecated)","use":"a","href":"#create-customer-deprecated","options":{"method":"post"}},{"id":"/docs/api/merchant/Legacy#retrieve-all-customers-deprecated","title":"Retrieve a customer list (Deprecated)","use":"a","href":"#retrieve-all-customers-deprecated","options":{"method":"get"}},{"id":"/docs/api/merchant/Legacy#retrieve-customer-deprecated","title":"Retrieve a customer (Deprecated)","use":"a","href":"#retrieve-customer-deprecated","options":{"method":"get"}},{"id":"/docs/api/merchant/Legacy#update-customer-deprecated","title":"Update a customer (Deprecated)","use":"a","href":"#update-customer-deprecated","options":{"method":"patch"}},{"id":"/docs/api/merchant/Legacy#delete-customer-deprecated","title":"Delete a customer (Deprecated)","use":"a","href":"#delete-customer-deprecated","options":{"method":"delete"}},{"id":"/docs/api/merchant/Legacy#retrieve-all-payment-methods-deprecated","title":"Retrieve all payment methods of a customer (Deprecated)","use":"a","href":"#retrieve-all-payment-methods-deprecated","options":{"method":"get"}},{"id":"/docs/api/merchant/Legacy#retrieve-payment-method-deprecated","title":"Retrieve a customer's payment method (Deprecated)","use":"a","href":"#retrieve-payment-method-deprecated","options":{"method":"get"}},{"id":"/docs/api/merchant/Legacy#update-payment-method-deprecated","title":"Update a customer's payment method (Deprecated)","use":"a","href":"#update-payment-method-deprecated","options":{"method":"patch"}},{"id":"/docs/api/merchant/Legacy#delete-payment-method-deprecated","title":"Delete a customer's payment method (Deprecated)","use":"a","href":"#delete-payment-method-deprecated","options":{"method":"delete"}}]},{"id":"/docs/api/merchant/Legacy#tag-payments","title":"Payments","use":"a","href":"#tag-payments","items":[{"id":"/docs/api/merchant/Legacy#retrieve-payment-details","title":"Retrieve payment details","use":"a","href":"#retrieve-payment-details","options":{"method":"get"}}]},{"id":"/docs/api/merchant/Legacy#tag-report-runs","title":"Report runs","use":"a","href":"#tag-report-runs","items":[{"id":"/docs/api/merchant/Legacy#create-report-run","title":"Create a report run","use":"a","href":"#create-report-run","options":{"method":"post"}},{"id":"/docs/api/merchant/Legacy#retrieve-report-run","title":"Retrieve a report run","use":"a","href":"#retrieve-report-run","options":{"method":"get"}},{"id":"/docs/api/merchant/Legacy#download-report-file","title":"Download report file","use":"a","href":"#download-report-file","options":{"method":"get"}}]},{"id":"/docs/api/merchant/Legacy#tag-webhooks","title":"Webhooks","use":"a","href":"#tag-webhooks","items":[{"id":"/docs/api/merchant/Legacy#create-webhook-deprecated","title":"Create a webhook (Deprecated)","use":"a","href":"#create-webhook-deprecated","options":{"method":"post"}},{"id":"/docs/api/merchant/Legacy#retrieve-all-webhooks-deprecated","title":"Retrieve a webhook list (Deprecated)","use":"a","href":"#retrieve-all-webhooks-deprecated","options":{"method":"get"}},{"id":"/docs/api/merchant/Legacy#retrieve-webhook-deprecated","title":"Retrieve a webhook (Deprecated)","use":"a","href":"#retrieve-webhook-deprecated","options":{"method":"get"}},{"id":"/docs/api/merchant/Legacy#update-webhook-deprecated","title":"Update a webhook (Deprecated)","use":"a","href":"#update-webhook-deprecated","options":{"method":"put"}},{"id":"/docs/api/merchant/Legacy#delete-webhook-deprecated","title":"Delete a webhook (Deprecated)","use":"a","href":"#delete-webhook-deprecated","options":{"method":"delete"}},{"id":"/docs/api/merchant/Legacy#rotate-webhook-signing-secret-deprecated","title":"Rotate a webhook signing secret (Deprecated)","use":"a","href":"#rotate-webhook-signing-secret-deprecated","options":{"method":"post"}}]},{"id":"/docs/api/merchant/Legacy#tag-locations","title":"Locations","use":"a","href":"#tag-locations","items":[{"id":"/docs/api/merchant/Legacy#create-location","title":"Create a location","use":"a","href":"#create-location","options":{"method":"post"}},{"id":"/docs/api/merchant/Legacy#retrieve-location-list","title":"Retrieve location list","use":"a","href":"#retrieve-location-list","options":{"method":"get"}},{"id":"/docs/api/merchant/Legacy#retrieve-location","title":"Retrieve a location","use":"a","href":"#retrieve-location","options":{"method":"get"}},{"id":"/docs/api/merchant/Legacy#update-location","title":"Update a location","use":"a","href":"#update-location","options":{"method":"patch"}},{"id":"/docs/api/merchant/Legacy#delete-location","title":"Delete a location","use":"a","href":"#delete-location","options":{"method":"delete"}}]},{"id":"/docs/api/merchant/Legacy#tag-apple-pay-merchant-registration","title":"Apple Pay merchant registration","use":"a","href":"#tag-apple-pay-merchant-registration","items":[{"id":"/docs/api/merchant/Legacy#register-domain-apple-pay","title":"Register domain for Apple Pay","use":"a","href":"#register-domain-apple-pay","options":{"method":"post"}},{"id":"/docs/api/merchant/Legacy#unregister-domain-apple-pay","title":"Unregister domain for Apple Pay","use":"a","href":"#unregister-domain-apple-pay","options":{"method":"post"}}]},{"id":"/docs/api/merchant/Legacy#tag-other","title":"Other","use":"a","href":"#tag-other","items":[{"id":"/docs/api/merchant/Legacy#register-address-validation-endpoint","title":"Register address validation endpoint for Fast checkout","use":"a","href":"#register-address-validation-endpoint","options":{"method":"post"}},{"id":"/docs/api/merchant/Legacy#retrieve-synchronous-webhook-list","title":"Retrieve a synchronous webhook list","use":"a","href":"#retrieve-synchronous-webhook-list","options":{"method":"get"}},{"id":"/docs/api/merchant/Legacy#delete-synchronous-webhook","title":"Delete a synchronous webhook","use":"a","href":"#delete-synchronous-webhook","options":{"method":"delete"}}]}],"versions":[{"label":"2026-08-17","path":"/docs/api/merchant","latest":true},{"label":"2026-04-20","path":"/docs/api/merchant/2026-04-20","latest":false},{"label":"2026-03-12","path":"/docs/api/merchant/2026-03-12","latest":false},{"label":"2025-12-04","path":"/docs/api/merchant/2025-12-04","latest":false},{"label":"2025-10-16","path":"/docs/api/merchant/2025-10-16","latest":false},{"label":"2024-09-01","path":"/docs/api/merchant/2024-09-01","latest":false},{"label":"2024-05-01","path":"/docs/api/merchant/2024-05-01","latest":false},{"label":"2023-09-01","path":"/docs/api/merchant/2023-09-01","latest":false},{"label":"Legacy","path":"/docs/api/merchant/Legacy","latest":false}]},"/docs/api/merchant":{"items":[{"id":"/docs/api/merchant#tag-orders","title":"Orders","use":"a","href":"#tag-orders","items":[{"id":"/docs/api/merchant#create-order","title":"Create an order","use":"a","href":"#create-order","options":{"method":"post"}},{"id":"/docs/api/merchant#retrieve-order-list","title":"Retrieve an order list","use":"a","href":"#retrieve-order-list","options":{"method":"get"}},{"id":"/docs/api/merchant#retrieve-order","title":"Retrieve an order","use":"a","href":"#retrieve-order","options":{"method":"get"}},{"id":"/docs/api/merchant#update-order","title":"Update an order","use":"a","href":"#update-order","options":{"method":"patch"}},{"id":"/docs/api/merchant#increment-authorisation","title":"Increment authorisation","use":"a","href":"#increment-authorisation","options":{"method":"post"}},{"id":"/docs/api/merchant#capture-order","title":"Capture an order","use":"a","href":"#capture-order","options":{"method":"post"}},{"id":"/docs/api/merchant#cancel-order","title":"Cancel an order","use":"a","href":"#cancel-order","options":{"method":"post"}},{"id":"/docs/api/merchant#refund-order","title":"Refund an order","use":"a","href":"#refund-order","options":{"method":"post"}},{"id":"/docs/api/merchant#pay-order","title":"Pay for an order","use":"a","href":"#pay-order","options":{"method":"post"}},{"id":"/docs/api/merchant#retrieve-payment-list","title":"Retrieve payment list of an order","use":"a","href":"#retrieve-payment-list","options":{"method":"get"}}]},{"id":"/docs/api/merchant#tag-customers","title":"Customers","use":"a","href":"#tag-customers","items":[{"id":"/docs/api/merchant#create-customer","title":"Create a customer","use":"a","href":"#create-customer","options":{"method":"post"}},{"id":"/docs/api/merchant#retrieve-customer-list","title":"Retrieve a customer list","use":"a","href":"#retrieve-customer-list","options":{"method":"get"}},{"id":"/docs/api/merchant#retrieve-customer","title":"Retrieve a customer","use":"a","href":"#retrieve-customer","options":{"method":"get"}},{"id":"/docs/api/merchant#update-customer","title":"Update a customer","use":"a","href":"#update-customer","options":{"method":"patch"}},{"id":"/docs/api/merchant#delete-customer","title":"Delete a customer","use":"a","href":"#delete-customer","options":{"method":"delete"}},{"id":"/docs/api/merchant#retrieve-payment-method-list","title":"Retrieve payment method list of a customer","use":"a","href":"#retrieve-payment-method-list","options":{"method":"get"}},{"id":"/docs/api/merchant#retrieve-payment-method","title":"Retrieve a customer's payment method","use":"a","href":"#retrieve-payment-method","options":{"method":"get"}},{"id":"/docs/api/merchant#update-payment-method","title":"Update a customer's payment method","use":"a","href":"#update-payment-method","options":{"method":"patch"}},{"id":"/docs/api/merchant#delete-payment-method","title":"Delete a customer's payment method","use":"a","href":"#delete-payment-method","options":{"method":"delete"}}]},{"id":"/docs/api/merchant#tag-payments","title":"Payments","use":"a","href":"#tag-payments","items":[{"id":"/docs/api/merchant#retrieve-payment-details","title":"Retrieve payment details","use":"a","href":"#retrieve-payment-details","options":{"method":"get"}}]},{"id":"/docs/api/merchant#tag-subscriptions","title":"Subscriptions","use":"a","href":"#tag-subscriptions","items":[{"id":"/docs/api/merchant#create-subscription-plan","title":"Create a subscription plan","use":"a","href":"#create-subscription-plan","options":{"method":"post"}},{"id":"/docs/api/merchant#retrieve-subscription-plan-list","title":"Retrieve a subscription plan list","use":"a","href":"#retrieve-subscription-plan-list","options":{"method":"get"}},{"id":"/docs/api/merchant#retrieve-subscription-plan","title":"Retrieve a subscription plan","use":"a","href":"#retrieve-subscription-plan","options":{"method":"get"}},{"id":"/docs/api/merchant#create-subscription","title":"Create a subscription","use":"a","href":"#create-subscription","options":{"method":"post"}},{"id":"/docs/api/merchant#retrieve-subscription-list","title":"Retrieve a subscription list","use":"a","href":"#retrieve-subscription-list","options":{"method":"get"}},{"id":"/docs/api/merchant#retrieve-subscription","title":"Retrieve a subscription","use":"a","href":"#retrieve-subscription","options":{"method":"get"}},{"id":"/docs/api/merchant#update-subscription","title":"Update a subscription","use":"a","href":"#update-subscription","options":{"method":"patch"}},{"id":"/docs/api/merchant#change-subscription-plan","title":"Change a subscription plan","use":"a","href":"#change-subscription-plan","options":{"method":"post"}},{"id":"/docs/api/merchant#update-subscription-renewal-date","title":"Update a subscription renewal date","use":"a","href":"#update-subscription-renewal-date","options":{"method":"post"}},{"id":"/docs/api/merchant#cancel-subscription","title":"Cancel a subscription","use":"a","href":"#cancel-subscription","options":{"method":"post"}},{"id":"/docs/api/merchant#retrieve-subscription-cycle-list","title":"Retrieve a subscription cycle list","use":"a","href":"#retrieve-subscription-cycle-list","options":{"method":"get"}},{"id":"/docs/api/merchant#retrieve-subscription-cycle","title":"Retrieve a subscription cycle","use":"a","href":"#retrieve-subscription-cycle","options":{"method":"get"}},{"id":"/docs/api/merchant#create-subscription-usage","title":"Create a subscription usage","use":"a","href":"#create-subscription-usage","options":{"method":"post"}},{"id":"/docs/api/merchant#retrieve-subscription-usage-list","title":"Retrieve a subscription usage list","use":"a","href":"#retrieve-subscription-usage-list","options":{"method":"get"}},{"id":"/docs/api/merchant#retrieve-subscription-usage","title":"Retrieve a subscription usage","use":"a","href":"#retrieve-subscription-usage","options":{"method":"get"}},{"id":"/docs/api/merchant#update-subscription-usage","title":"Update a subscription usage","use":"a","href":"#update-subscription-usage","options":{"method":"patch"}},{"id":"/docs/api/merchant#delete-subscription-usage","title":"Delete a subscription usage","use":"a","href":"#delete-subscription-usage","options":{"method":"delete"}}]},{"id":"/docs/api/merchant#tag-payouts","title":"Payouts","use":"a","href":"#tag-payouts","items":[{"id":"/docs/api/merchant#create-payout","title":"Create a payout","use":"a","href":"#create-payout","options":{"method":"post"}},{"id":"/docs/api/merchant#retrieve-payout-list","title":"Retrieve a payout list","use":"a","href":"#retrieve-payout-list","options":{"method":"get"}},{"id":"/docs/api/merchant#retrieve-payout","title":"Retrieve a payout","use":"a","href":"#retrieve-payout","options":{"method":"get"}}]},{"id":"/docs/api/merchant#tag-disputes","title":"Disputes","use":"a","href":"#tag-disputes","items":[{"id":"/docs/api/merchant#retrieve-dispute-list","title":"Retrieve a dispute list","use":"a","href":"#retrieve-dispute-list","options":{"method":"get"}},{"id":"/docs/api/merchant#retrieve-dispute","title":"Retrieve a dispute","use":"a","href":"#retrieve-dispute","options":{"method":"get"}},{"id":"/docs/api/merchant#accept-dispute","title":"Accept a dispute","use":"a","href":"#accept-dispute","options":{"method":"post"}},{"id":"/docs/api/merchant#upload-dispute-evidence","title":"Upload evidence for a dispute","use":"a","href":"#upload-dispute-evidence","options":{"method":"post"}},{"id":"/docs/api/merchant#challenge-dispute","title":"Challenge a dispute","use":"a","href":"#challenge-dispute","options":{"method":"post"}}]},{"id":"/docs/api/merchant#tag-report-runs","title":"Report runs","use":"a","href":"#tag-report-runs","items":[{"id":"/docs/api/merchant#create-report-run","title":"Create a report run","use":"a","href":"#create-report-run","options":{"method":"post"}},{"id":"/docs/api/merchant#retrieve-report-run","title":"Retrieve a report run","use":"a","href":"#retrieve-report-run","options":{"method":"get"}},{"id":"/docs/api/merchant#download-report-file","title":"Download report file","use":"a","href":"#download-report-file","options":{"method":"get"}}]},{"id":"/docs/api/merchant#tag-webhooks","title":"Webhooks","use":"a","href":"#tag-webhooks","items":[{"id":"/docs/api/merchant#create-webhook","title":"Create a webhook","use":"a","href":"#create-webhook","options":{"method":"post"}},{"id":"/docs/api/merchant#retrieve-webhook-list","title":"Retrieve a webhook list","use":"a","href":"#retrieve-webhook-list","options":{"method":"get"}},{"id":"/docs/api/merchant#retrieve-webhook","title":"Retrieve a webhook","use":"a","href":"#retrieve-webhook","options":{"method":"get"}},{"id":"/docs/api/merchant#update-webhook","title":"Update a webhook","use":"a","href":"#update-webhook","options":{"method":"patch"}},{"id":"/docs/api/merchant#delete-webhook","title":"Delete a webhook","use":"a","href":"#delete-webhook","options":{"method":"delete"}},{"id":"/docs/api/merchant#rotate-webhook-signing-secret","title":"Rotate a webhook signing secret","use":"a","href":"#rotate-webhook-signing-secret","options":{"method":"post"}},{"id":"/docs/api/merchant#webhook-webhook-event","title":"Webhook event","use":"a","href":"#webhook-webhook-event","options":{"method":"webhook"}}]},{"id":"/docs/api/merchant#tag-locations","title":"Locations","use":"a","href":"#tag-locations","items":[{"id":"/docs/api/merchant#create-location","title":"Create a location","use":"a","href":"#create-location","options":{"method":"post"}},{"id":"/docs/api/merchant#retrieve-location-list","title":"Retrieve location list","use":"a","href":"#retrieve-location-list","options":{"method":"get"}},{"id":"/docs/api/merchant#retrieve-location","title":"Retrieve a location","use":"a","href":"#retrieve-location","options":{"method":"get"}},{"id":"/docs/api/merchant#update-location","title":"Update a location","use":"a","href":"#update-location","options":{"method":"patch"}},{"id":"/docs/api/merchant#delete-location","title":"Delete a location","use":"a","href":"#delete-location","options":{"method":"delete"}}]},{"id":"/docs/api/merchant#tag-terminals","title":"Terminals","use":"a","href":"#tag-terminals","items":[{"id":"/docs/api/merchant#retrieve-terminal-list","title":"Retrieve terminal list","use":"a","href":"#retrieve-terminal-list","options":{"method":"get"}}]},{"id":"/docs/api/merchant#tag-payment-intents","title":"Payment intents","use":"a","href":"#tag-payment-intents","items":[{"id":"/docs/api/merchant#create-payment-intent","title":"Create a payment intent","use":"a","href":"#create-payment-intent","options":{"method":"post"}},{"id":"/docs/api/merchant#retrieve-payment-intent","title":"Retrieve a payment intent","use":"a","href":"#retrieve-payment-intent","options":{"method":"get"}},{"id":"/docs/api/merchant#cancel-payment-intent","title":"Cancel a payment intent","use":"a","href":"#cancel-payment-intent","options":{"method":"post"}}]},{"id":"/docs/api/merchant#tag-apple-pay-merchant-registration","title":"Apple Pay merchant registration","use":"a","href":"#tag-apple-pay-merchant-registration","items":[{"id":"/docs/api/merchant#register-domain-apple-pay","title":"Register domain for Apple Pay","use":"a","href":"#register-domain-apple-pay","options":{"method":"post"}},{"id":"/docs/api/merchant#unregister-domain-apple-pay","title":"Unregister domain for Apple Pay","use":"a","href":"#unregister-domain-apple-pay","options":{"method":"post"}}]},{"id":"/docs/api/merchant#tag-other","title":"Other","use":"a","href":"#tag-other","items":[{"id":"/docs/api/merchant#register-address-validation-endpoint","title":"Register address validation endpoint for Fast checkout","use":"a","href":"#register-address-validation-endpoint","options":{"method":"post"}},{"id":"/docs/api/merchant#retrieve-synchronous-webhook-list","title":"Retrieve a synchronous webhook list","use":"a","href":"#retrieve-synchronous-webhook-list","options":{"method":"get"}},{"id":"/docs/api/merchant#delete-synchronous-webhook","title":"Delete a synchronous webhook","use":"a","href":"#delete-synchronous-webhook","options":{"method":"delete"}}]}],"versions":[{"label":"2026-08-17","path":"/docs/api/merchant","latest":true},{"label":"2026-04-20","path":"/docs/api/merchant/2026-04-20","latest":false},{"label":"2026-03-12","path":"/docs/api/merchant/2026-03-12","latest":false},{"label":"2025-12-04","path":"/docs/api/merchant/2025-12-04","latest":false},{"label":"2025-10-16","path":"/docs/api/merchant/2025-10-16","latest":false},{"label":"2024-09-01","path":"/docs/api/merchant/2024-09-01","latest":false},{"label":"2024-05-01","path":"/docs/api/merchant/2024-05-01","latest":false},{"label":"2023-09-01","path":"/docs/api/merchant/2023-09-01","latest":false},{"label":"Legacy","path":"/docs/api/merchant/Legacy","latest":false}]},"/docs/api/open-banking":{"items":[{"id":"/docs/api/open-banking#tag-applications","title":"Applications","use":"a","href":"#tag-applications","items":[{"id":"/docs/api/open-banking#get-distinguished-name","title":"Get a distinguished name (DN)","use":"a","href":"#get-distinguished-name","options":{"method":"get"}},{"id":"/docs/api/open-banking#register-application","title":"Register an application","use":"a","href":"#register-application","options":{"method":"post"}},{"id":"/docs/api/open-banking#get-application","title":"Get an application","use":"a","href":"#get-application","options":{"method":"get"}},{"id":"/docs/api/open-banking#update-application","title":"Update an application","use":"a","href":"#update-application","options":{"method":"put"}},{"id":"/docs/api/open-banking#delete-application","title":"Delete an application","use":"a","href":"#delete-application","options":{"method":"delete"}}]},{"id":"/docs/api/open-banking#tag-accounts","title":"Accounts","use":"a","href":"#tag-accounts","items":[{"id":"/docs/api/open-banking#create-account-access-consents","title":"Create an account access consent","use":"a","href":"#create-account-access-consents","options":{"method":"post"}},{"id":"/docs/api/open-banking#get-account-access-consents-consent-id","title":"Retrieve an account access consent","use":"a","href":"#get-account-access-consents-consent-id","options":{"method":"get"}},{"id":"/docs/api/open-banking#delete-account-access-consents-consent-id","title":"Delete an account access consent","use":"a","href":"#delete-account-access-consents-consent-id","options":{"method":"delete"}},{"id":"/docs/api/open-banking#get-accounts","title":"Retrieve all accounts","use":"a","href":"#get-accounts","options":{"method":"get"}},{"id":"/docs/api/open-banking#get-accounts-account-id","title":"Retrieve an account","use":"a","href":"#get-accounts-account-id","options":{"method":"get"}},{"id":"/docs/api/open-banking#get-accounts-account-id-balances","title":"Retrieve an account balance","use":"a","href":"#get-accounts-account-id-balances","options":{"method":"get"}},{"id":"/docs/api/open-banking#get-accounts-account-id-beneficiaries","title":"Retrieve all account's beneficiaries","use":"a","href":"#get-accounts-account-id-beneficiaries","options":{"method":"get"}}]},{"id":"/docs/api/open-banking#tag-transactions","title":"Transactions","use":"a","href":"#tag-transactions","items":[{"id":"/docs/api/open-banking#get-accounts-account-id-direct-debits","title":"Retrieve all account's direct debits","use":"a","href":"#get-accounts-account-id-direct-debits","options":{"method":"get"}},{"id":"/docs/api/open-banking#get-accounts-account-id-standing-orders","title":"Retrieve all account's standing orders","use":"a","href":"#get-accounts-account-id-standing-orders","options":{"method":"get"}},{"id":"/docs/api/open-banking#get-accounts-account-id-transactions","title":"Retrieve all transactions","use":"a","href":"#get-accounts-account-id-transactions","options":{"method":"get"}}]},{"id":"/docs/api/open-banking#tag-domestic-payment","title":"Domestic payment","use":"a","href":"#tag-domestic-payment","items":[{"id":"/docs/api/open-banking#create-domestic-payment-consents","title":"Create a domestic payment consent","use":"a","href":"#create-domestic-payment-consents","options":{"method":"post"}},{"id":"/docs/api/open-banking#get-domestic-payment-consents-consent-id","title":"Retrieve a domestic payment consent","use":"a","href":"#get-domestic-payment-consents-consent-id","options":{"method":"get"}},{"id":"/docs/api/open-banking#get-domestic-payment-consents-consent-id-funds-confirmation","title":"Get funds confirmation for a domestic payment consent","use":"a","href":"#get-domestic-payment-consents-consent-id-funds-confirmation","options":{"method":"get"}},{"id":"/docs/api/open-banking#create-domestic-payments","title":"Create a domestic payment","use":"a","href":"#create-domestic-payments","options":{"method":"post"}},{"id":"/docs/api/open-banking#get-domestic-payments-domestic-payment-id","title":"Retrieve a domestic payment","use":"a","href":"#get-domestic-payments-domestic-payment-id","options":{"method":"get"}}]},{"id":"/docs/api/open-banking#tag-domestic-scheduled-payment","title":"Domestic scheduled payment","use":"a","href":"#tag-domestic-scheduled-payment","items":[{"id":"/docs/api/open-banking#create-domestic-scheduled-payment-consents","title":"Create a domestic scheduled payment consent","use":"a","href":"#create-domestic-scheduled-payment-consents","options":{"method":"post"}},{"id":"/docs/api/open-banking#get-domestic-scheduled-payment-consents-consent-id","title":"Retrieve a domestic scheduled payment consent","use":"a","href":"#get-domestic-scheduled-payment-consents-consent-id","options":{"method":"get"}},{"id":"/docs/api/open-banking#create-domestic-scheduled-payments","title":"Create a domestic scheduled payment","use":"a","href":"#create-domestic-scheduled-payments","options":{"method":"post"}},{"id":"/docs/api/open-banking#get-domestic-scheduled-payments-domestic-scheduled-payment-id","title":"Retrieve a domestic scheduled payment","use":"a","href":"#get-domestic-scheduled-payments-domestic-scheduled-payment-id","options":{"method":"get"}}]},{"id":"/docs/api/open-banking#tag-domestic-standing-order","title":"Domestic standing order","use":"a","href":"#tag-domestic-standing-order","items":[{"id":"/docs/api/open-banking#create-domestic-standing-order-consents","title":"Create a domestic standing order consent","use":"a","href":"#create-domestic-standing-order-consents","options":{"method":"post"}},{"id":"/docs/api/open-banking#get-domestic-standing-order-consents-consent-id","title":"Retrieve a domestic standing order consent","use":"a","href":"#get-domestic-standing-order-consents-consent-id","options":{"method":"get"}},{"id":"/docs/api/open-banking#create-domestic-standing-orders","title":"Create a domestic standing order","use":"a","href":"#create-domestic-standing-orders","options":{"method":"post"}},{"id":"/docs/api/open-banking#get-domestic-standing-orders-domestic-standing-order-id","title":"Retrieve a domestic standing order","use":"a","href":"#get-domestic-standing-orders-domestic-standing-order-id","options":{"method":"get"}}]},{"id":"/docs/api/open-banking#tag-file-payment","title":"File payment","use":"a","href":"#tag-file-payment","items":[{"id":"/docs/api/open-banking#create-file-payment-consents","title":"Create a file payment consent","use":"a","href":"#create-file-payment-consents","options":{"method":"post"}},{"id":"/docs/api/open-banking#get-file-payment-consents-consent-id","title":"Retrieve a file payment consent","use":"a","href":"#get-file-payment-consents-consent-id","options":{"method":"get"}},{"id":"/docs/api/open-banking#get-file-payment-consents-consent-id-file","title":"Retrieve an uploaded payment file","use":"a","href":"#get-file-payment-consents-consent-id-file","options":{"method":"get"}},{"id":"/docs/api/open-banking#create-file-payment-consents-consent-id-file","title":"Upload a payment file","use":"a","href":"#create-file-payment-consents-consent-id-file","options":{"method":"post"}},{"id":"/docs/api/open-banking#create-file-payments","title":"Create a file payment","use":"a","href":"#create-file-payments","options":{"method":"post"}},{"id":"/docs/api/open-banking#get-file-payments-file-payment-id","title":"Retrieve a file payment","use":"a","href":"#get-file-payments-file-payment-id","options":{"method":"get"}},{"id":"/docs/api/open-banking#get-file-payments-file-payment-id-report-file","title":"Retrieve all payments of a file payment","use":"a","href":"#get-file-payments-file-payment-id-report-file","options":{"method":"get"}}]},{"id":"/docs/api/open-banking#tag-international-payment","title":"International payment","use":"a","href":"#tag-international-payment","items":[{"id":"/docs/api/open-banking#create-international-payment-consents","title":"Create an international payment consent","use":"a","href":"#create-international-payment-consents","options":{"method":"post"}},{"id":"/docs/api/open-banking#get-international-payment-consents-consent-id","title":"Retrieve an international payment consent","use":"a","href":"#get-international-payment-consents-consent-id","options":{"method":"get"}},{"id":"/docs/api/open-banking#get-international-payment-consents-consent-id-funds-confirmation","title":"Get funds confirmation for an international payment consent","use":"a","href":"#get-international-payment-consents-consent-id-funds-confirmation","options":{"method":"get"}},{"id":"/docs/api/open-banking#create-international-payments","title":"Create an international payment","use":"a","href":"#create-international-payments","options":{"method":"post"}},{"id":"/docs/api/open-banking#get-international-payments-international-payment-id","title":"Retrieve an international payment","use":"a","href":"#get-international-payments-international-payment-id","options":{"method":"get"}}]},{"id":"/docs/api/open-banking#tag-international-scheduled-payment","title":"International scheduled payment","use":"a","href":"#tag-international-scheduled-payment","items":[{"id":"/docs/api/open-banking#create-international-scheduled-payment-consents","title":"Create an international scheduled payment consent","use":"a","href":"#create-international-scheduled-payment-consents","options":{"method":"post"}},{"id":"/docs/api/open-banking#get-international-scheduled-payment-consents-consent-id","title":"Retrieve an international scheduled payment consent","use":"a","href":"#get-international-scheduled-payment-consents-consent-id","options":{"method":"get"}},{"id":"/docs/api/open-banking#get-international-scheduled-payment-consents-consent-id-funds-confirmation","title":"Get funds confirmation for an international scheduled payment","use":"a","href":"#get-international-scheduled-payment-consents-consent-id-funds-confirmation","options":{"method":"get"}},{"id":"/docs/api/open-banking#create-international-scheduled-payments","title":"Create an international scheduled payment","use":"a","href":"#create-international-scheduled-payments","options":{"method":"post"}},{"id":"/docs/api/open-banking#get-international-scheduled-payments-international-scheduled-payment-id","title":"Retrieve an international scheduled payment","use":"a","href":"#get-international-scheduled-payments-international-scheduled-payment-id","options":{"method":"get"}}]},{"id":"/docs/api/open-banking#tag-international-standing-order","title":"International standing order","use":"a","href":"#tag-international-standing-order","items":[{"id":"/docs/api/open-banking#create-international-standing-order-consents","title":"Create an international standing order consent","use":"a","href":"#create-international-standing-order-consents","options":{"method":"post"}},{"id":"/docs/api/open-banking#get-international-standing-order-consents-consent-id","title":"Retrieve an international standing order consent","use":"a","href":"#get-international-standing-order-consents-consent-id","options":{"method":"get"}},{"id":"/docs/api/open-banking#create-international-standing-orders","title":"Create an international standing order","use":"a","href":"#create-international-standing-orders","options":{"method":"post"}},{"id":"/docs/api/open-banking#get-international-standing-orders-international-standing-order-id","title":"Retrieve an international standing order","use":"a","href":"#get-international-standing-orders-international-standing-order-id","options":{"method":"get"}}]},{"id":"/docs/api/open-banking#tag-draft-payment","title":"Draft payment","use":"a","href":"#tag-draft-payment","items":[{"id":"/docs/api/open-banking#list-draft-payment","title":"List draft payments","use":"a","href":"#list-draft-payment","options":{"method":"get"}},{"id":"/docs/api/open-banking#create-draft-payment","title":"Create a draft payment","use":"a","href":"#create-draft-payment","options":{"method":"post"}},{"id":"/docs/api/open-banking#delete-draft-payment-transfer","title":"Delete a draft payment transfer","use":"a","href":"#delete-draft-payment-transfer","options":{"method":"delete"}},{"id":"/docs/api/open-banking#find-draft-payment","title":"Retrieve a draft payment","use":"a","href":"#find-draft-payment","options":{"method":"get"}},{"id":"/docs/api/open-banking#delete-draft-payment","title":"Delete a draft payment","use":"a","href":"#delete-draft-payment","options":{"method":"delete"}}]}],"versions":"$undefined"},"/docs/api/revolut-wallet-callbacks":{"items":[{"id":"/docs/api/revolut-wallet-callbacks#tag-preview-transaction-outcomes","title":"[PREVIEW] Transaction outcomes","use":"a","href":"#tag-preview-transaction-outcomes","items":[{"id":"/docs/api/revolut-wallet-callbacks#search-transaction-outcomes","title":"[PREVIEW] Fetch transaction outcomes for a transaction","use":"a","href":"#search-transaction-outcomes","options":{"method":"post"}}]},{"id":"/docs/api/revolut-wallet-callbacks#tag-preview-passes","title":"[PREVIEW] Passes","use":"a","href":"#tag-preview-passes","items":[{"id":"/docs/api/revolut-wallet-callbacks#fetch-pass","title":"[PREVIEW] Retrieve a pass","use":"a","href":"#fetch-pass","options":{"method":"get"}}]}],"versions":"$undefined"},"/docs/api/revolut-wallet-partner":{"items":[{"id":"/docs/api/revolut-wallet-partner#tag-preview-passes","title":"[PREVIEW] Passes","use":"a","href":"#tag-preview-passes","items":[{"id":"/docs/api/revolut-wallet-partner#create-pass","title":"[PREVIEW] Create a pass","use":"a","href":"#create-pass","options":{"method":"post"}},{"id":"/docs/api/revolut-wallet-partner#push-pass-update","title":"[PREVIEW] Update a pass","use":"a","href":"#push-pass-update","options":{"method":"put"}}]}],"versions":"$undefined"},"/docs/api/revolut-x-crypto-exchange":{"items":[{"id":"/docs/api/revolut-x-crypto-exchange#tag-public-market-data","title":"Public market data","use":"a","href":"#tag-public-market-data","items":[{"id":"/docs/api/revolut-x-crypto-exchange#get-order-book-public","title":"Get order book","use":"a","href":"#get-order-book-public","options":{"method":"get"}},{"id":"/docs/api/revolut-x-crypto-exchange#get-tickers-public","title":"Get tickers","use":"a","href":"#get-tickers-public","options":{"method":"get"}},{"id":"/docs/api/revolut-x-crypto-exchange#get-candles-public","title":"Get OHLCV candles","use":"a","href":"#get-candles-public","options":{"method":"get"}},{"id":"/docs/api/revolut-x-crypto-exchange#get-trade-history-public","title":"Get trade history","use":"a","href":"#get-trade-history-public","options":{"method":"get"}},{"id":"/docs/api/revolut-x-crypto-exchange#get-currencies-public","title":"Get currencies","use":"a","href":"#get-currencies-public","options":{"method":"get"}},{"id":"/docs/api/revolut-x-crypto-exchange#get-currency-pairs-public","title":"Get currency pairs","use":"a","href":"#get-currency-pairs-public","options":{"method":"get"}}]},{"id":"/docs/api/revolut-x-crypto-exchange#tag-market-data","title":"Market data","use":"a","href":"#tag-market-data","items":[{"id":"/docs/api/revolut-x-crypto-exchange#get-order-book","title":"Get order book","use":"a","href":"#get-order-book","options":{"method":"get"}},{"id":"/docs/api/revolut-x-crypto-exchange#get-tickers","title":"Get tickers","use":"a","href":"#get-tickers","options":{"method":"get"}},{"id":"/docs/api/revolut-x-crypto-exchange#get-candles","title":"Get OHLCV candles","use":"a","href":"#get-candles","options":{"method":"get"}},{"id":"/docs/api/revolut-x-crypto-exchange#get-trade-history","title":"Get trade history","use":"a","href":"#get-trade-history","options":{"method":"get"}},{"id":"/docs/api/revolut-x-crypto-exchange#get-currencies","title":"Get currencies","use":"a","href":"#get-currencies","options":{"method":"get"}},{"id":"/docs/api/revolut-x-crypto-exchange#get-currency-pairs","title":"Get currency pairs","use":"a","href":"#get-currency-pairs","options":{"method":"get"}}]},{"id":"/docs/api/revolut-x-crypto-exchange#tag-account-data","title":"Account data","use":"a","href":"#tag-account-data","items":[{"id":"/docs/api/revolut-x-crypto-exchange#get-all-balances","title":"Get balances","use":"a","href":"#get-all-balances","options":{"method":"get"}},{"id":"/docs/api/revolut-x-crypto-exchange#get-active-orders","title":"Get active orders","use":"a","href":"#get-active-orders","options":{"method":"get"}},{"id":"/docs/api/revolut-x-crypto-exchange#get-historical-orders","title":"Get historical orders","use":"a","href":"#get-historical-orders","options":{"method":"get"}},{"id":"/docs/api/revolut-x-crypto-exchange#get-order","title":"Get order details by ID","use":"a","href":"#get-order","options":{"method":"get"}},{"id":"/docs/api/revolut-x-crypto-exchange#get-order-fills","title":"Get fills of order by ID","use":"a","href":"#get-order-fills","options":{"method":"get"}},{"id":"/docs/api/revolut-x-crypto-exchange#get-private-trades","title":"Get account trades","use":"a","href":"#get-private-trades","options":{"method":"get"}},{"id":"/docs/api/revolut-x-crypto-exchange#get-transactions","title":"Get transactions","use":"a","href":"#get-transactions","options":{"method":"get"}}]},{"id":"/docs/api/revolut-x-crypto-exchange#tag-trading","title":"Trading","use":"a","href":"#tag-trading","items":[{"id":"/docs/api/revolut-x-crypto-exchange#place-order","title":"Place order","use":"a","href":"#place-order","options":{"method":"post"}},{"id":"/docs/api/revolut-x-crypto-exchange#cancel-all-orders","title":"Cancel all active orders","use":"a","href":"#cancel-all-orders","options":{"method":"delete"}},{"id":"/docs/api/revolut-x-crypto-exchange#cancel-order","title":"Cancel order by ID","use":"a","href":"#cancel-order","options":{"method":"delete"}},{"id":"/docs/api/revolut-x-crypto-exchange#replace-order","title":"Replace order","use":"a","href":"#replace-order","options":{"method":"put"}}]},{"id":"/docs/api/revolut-x-crypto-exchange#tag-deprecated","title":"Deprecated","use":"a","href":"#tag-deprecated","items":[{"id":"/docs/api/revolut-x-crypto-exchange#get-last-trades-deprecated","title":"Get last trades (deprecated)","use":"a","href":"#get-last-trades-deprecated","options":{"method":"get"}},{"id":"/docs/api/revolut-x-crypto-exchange#get-public-order-book-deprecated","title":"Get order book (deprecated)","use":"a","href":"#get-public-order-book-deprecated","options":{"method":"get"}}]}],"versions":"$undefined"}},"alphaByPath":{}},"children":["$undefined","$L4","$L5"]}]}]]}]} 4:[["$","title",null,{"children":"Build a per-seat subscription model | Developer"}],["$","meta",null,{"property":"og:title","content":"Build a per-seat subscription model | Developer"}],[["$","meta",null,{"name":"description","content":"Bill a unit price for every seat - with a seat count that's fixed on the plan or reported dynamically as your customer's team changes."}],["$","meta",null,{"property":"og:description","content":"Bill a unit price for every seat - with a seat count that's fixed on the plan or reported dynamically as your customer's team changes."}]],["$","meta",null,{"name":"keywords","content":"per-seat subscription,seat-based pricing,quantity billing,usage item,latest aggregation,active seats"}],["$","meta",null,{"property":"og:url","content":"https://developer.revolut.com/docs/guides/merchant/billing-subscriptions/api/per-seat"}],[["$","meta",null,{"property":"og:image","content":"https://developer.revolut.com/_assets/og/docs/guides/merchant/billing-subscriptions/api/per-seat.png"}],["$","meta",null,{"property":"og:image:width","content":"1200"}],["$","meta",null,{"property":"og:image:height","content":"630"}],["$","meta",null,{"property":"og:image:type","content":"image/png"}],["$","meta",null,{"name":"twitter:card","content":"summary_large_image"}]],["$","$L6",null,{"children":["$","div",null,{"data-variant":"default","data-has-feed":true,"data-revpress":"layout","className":"wp3eky1","children":[["$","$L7",null,{"actions":"$undefined"}],["$","$L8",null,{}],[["$","main",null,{"data-variant":"$undefined","className":"_12jbm4g0","children":[["$","nav",null,{"className":"e43y4a0","data-event-key":"breadcrumbs","children":["$","ol",null,{"className":"e43y4a1","children":[["$","li","/-0",{"className":"e43y4a2","children":["$","$L2",null,{"className":"e43y4a3","to":"/","children":"Home"}]}],["$","li","Merchant-1",{"className":"e43y4a2","children":"Merchant"}],["$","li","Billing & subscriptions-2",{"className":"e43y4a2","children":"Billing & subscriptions"}],["$","li","API-3",{"className":"e43y4a2","children":"API"}],["$","li","Per-seat subscription-4",{"className":"e43y4a2","children":null}]]}]}],["$","div",null,{"className":"_10qzu533","children":[[["$","div",null,{"className":"nizrjz0","children":[["$","h1",null,{"className":"nizrjz2","children":"Build a per-seat subscription model"}],["$","div",null,{"className":"nizrjz1","children":"$undefined"}]]}],["$","$L9",null,{"url":"/docs/guides/merchant/billing-subscriptions/api/per-seat.md"}],["$","article",null,{"className":"_8qmzte0","children":["$","$La","docs/guides/merchant/billing-subscriptions/api/per-seat.md",{"fallback":["$","$Lb",null,{"my":"auto","mx":"auto","width":"100%","maxWidth":500,"children":["$","$Lc",null,{"children":[["$","$Ld",null,{"icon":"ExclamationTriangle"}],["$","$Le",null,{"children":"Content could not be rendered"}],["$","$Lf",null,{"maxWidth":320,"children":[null,["$","div",null,{"children":"This content is unavailable."}]]}]]}]}],"children":[null,"\n",["$","p","p-0",{"children":["$","strong","strong-0",{"children":"Bill a unit price for every seat - with a seat count that's fixed on the plan or reported as it changes."}]}],"\n",["$","p","p-1",{"children":"Per-seat pricing bills a unit price for each user, licence, or device: £15.00 per seat per month, however many seats the customer has. The Merchant API supports two shapes, and the one you pick determines how seat counts are handled for the life of the subscription:"}],"\n",["$","ul","ul-0",{"children":["\n",["$","li","li-0",{"children":[["$","strong","strong-0",{"children":"Static seats"}]," - the seat count is fixed on the plan as a ",["$","code","code-0",{"children":"flat"}]," item with a ",["$","code","code-1",{"children":"quantity"}],". Every cycle bills the same amount, and seat changes go through a scheduled plan change."]}],"\n",["$","li","li-1",{"children":[["$","strong","strong-0",{"children":"Dynamic seats"}]," - the plan carries a ",["$","code","code-0",{"children":"usage"}]," item with ",["$","code","code-1",{"children":"latest"}]," aggregation. You report the current seat count through the usage API whenever it changes, and each cycle bills the count you most recently reported."]}],"\n"]}],"\n",["$","p","p-2",{"children":["In this guide, you sell a ",["$","strong","strong-0",{"children":"Team plan"}]," - £15.00 per seat per month, offered three ways: a 5-seat pack for £75.00 a month, a 10-seat pack for £150.00, and a flexible option that bills whatever seat count you report."]}],"\n","$L10","\n","$L11","\n","$L12","\n","$L13","\n","$L14","\n","$L15","\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n","$L16","\n","$L17","\n","$L18","\n","$L19","\n","$L1a","\n","$L1b","\n","$L1c","\n","$L1d","\n","$L1e","\n","$L1f","\n","$L20","\n","$L21","\n","$L22","\n","$L23","\n","$L24","\n","$L25","\n","$L26","\n","$L27","\n","$L28","\n","$L29","\n","$L2a","\n","$L2b","\n","$L2c","\n","$L2d","\n","$L2e","\n","$L2f","\n","$L30","\n","$L31","\n","$L32","\n","$L33","\n","$L34","\n","$L35","\n","$L36","\n","$L37","\n","$L38","\n","$L39","\n","$L3a","\n","$L3b","\n","$L3c","\n","$L3d","\n","$L3e","\n","$L3f","\n","$L40","\n","$L41","\n","$L42","\n","$L43","\n","$L44","\n","$L45","\n","$L46","\n","$L47","\n","$L48","\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n","$L49","\n","$L4a","\n","$L4b","\n","$L4c","\n","$L4d","\n","$L4e","\n","$L4f","\n","$L50","\n","$L51","\n","$L52","\n","$L53","\n","$L54","\n","$L55","\n","$L56","\n","$L57","\n","$L58","\n","$L59","\n","$L5a","\n","$L5b","\n","$L5c","\n","$L5d","\n","$L5e","\n","$L5f","\n","$L60","\n","$L61","\n","$L62","\n","$L63","\n","$L64","\n","$L65","\n","\n","$L66","\n","$L67","\n","$L68"]}]}]],"$L69"]}],"$L6a","$L6b","$L6c"]}],"$L6d"],"$L6e"]}]}]] 5:["$","footer",null,{"className":"_19k157u0","children":["$","div",null,{"className":"_19k157u1","children":[["$","div",null,{"className":"_19k157u2","children":[["$","img",null,{"data-revpress-display":"light","className":"_19k157u8","src":"https://assets.revolut.com/Brand/Retail/Logos/Wordmark/Revolut_Black.svg","alt":"Revolut"}],["$","img",null,{"data-revpress-display":"dark","className":"_19k157u8","src":"https://assets.revolut.com/Brand/Retail/Logos/Wordmark/Revolut_White.svg","alt":"Revolut"}],[["$","div","0",{"className":"_19k157u4","children":[["$","span",null,{"className":"_19k157u3","children":"Company and products"}],[["$","$L2","0",{"className":"_19k157u5","to":"https://revolut.com/","children":"Discover Revolut"}],["$","$L2","1",{"className":"_19k157u5","to":"https://www.revolut.com/careers/","children":"Join the team!"}],["$","$L2","2",{"className":"_19k157u5","to":"mailto:api-requests@revolut.com","children":"Email us for API support"}]]]}],["$","div","1",{"className":"_19k157u4","children":[["$","span",null,{"className":"_19k157u3","children":"Build Banking Apps"}],[["$","$L2","0",{"className":"_19k157u5","to":"/docs/guides/build-banking-apps/introduction-to-the-open-banking-api/introduction","children":"Documentation"}],["$","$L2","1",{"className":"_19k157u5","to":"/docs/api/open-banking","children":"Open Banking API"}],["$","$L2","2",{"className":"_19k157u5","to":"/docs/guides/build-banking-apps/api-metrics","children":"API Status"}],["$","$L2","3",{"className":"_19k157u5","to":"https://developer.revolut.com/portal/signup","children":"Developer Portal"}],["$","$L2","4",{"className":"_19k157u5","to":"mailto:api-requests@revolut.com","children":"Request Sandbox access"}]]]}],["$","div","2",{"className":"_19k157u4","children":[["$","span",null,{"className":"_19k157u3","children":"Manage Accounts"}],[["$","$L2","0",{"className":"_19k157u5","to":"/docs/guides/manage-accounts/introduction","children":"Documentation"}],["$","$L2","1",{"className":"_19k157u5","to":"/docs/api/business","children":"Business API"}]]]}],["$","div","3",{"className":"_19k157u4","children":[["$","span",null,{"className":"_19k157u3","children":"Accept Payments"}],[["$","$L2","0",{"className":"_19k157u5","to":"/docs/guides/merchant/introduction","children":"Documentation"}],["$","$L2","1",{"className":"_19k157u5","to":"/docs/api/merchant","children":"Merchant API"}],["$","$L2","2",{"className":"_19k157u5","to":"/docs/sdks/merchant-web-sdk/introduction","children":"Merchant Web SDKs"}],["$","$L2","3",{"className":"_19k157u5","to":"/docs/sdks/merchant-ios-sdk/introduction","children":"Merchant iOS SDKs"}],["$","$L2","4",{"className":"_19k157u5","to":"/docs/sdks/merchant-android-sdk/introduction","children":"Merchant Android SDKs"}]]]}],["$","div","4",{"className":"_19k157u4","children":[["$","span",null,{"className":"_19k157u3","children":"In-person Payments"}],[["$","$L2","0",{"className":"_19k157u5","to":"/docs/guides/merchant/accept-payments/in-person-payments/introduction","children":"Documentation"}],["$","$L2","1",{"className":"_19k157u5","to":"/docs/guides/merchant/accept-payments/in-person-payments/pos/introduction","children":"Revolut POS"}],["$","$L2","2",{"className":"_19k157u5","to":"https://apps.apple.com/gb/app/revolut-pos/id1604861598","children":"Download the Revolut POS app"}],["$","$L2","3",{"className":"_19k157u5","to":"/docs/guides/merchant/accept-payments/in-person-payments/reader/introduction","children":"Revolut Reader"}],["$","$L2","4",{"className":"_19k157u5","to":"/docs/guides/merchant/accept-payments/in-person-payments/terminal/introduction","children":"Revolut Terminal"}]]]}]]]}],["$","div",null,{"data-has-links":true,"className":"_19k157u6","children":[["$","p",null,{"className":"_19k157u7","children":["© Revolut Ltd ",2026]}],[["$","p","0",{"className":"_19k157u7","children":"If you would like to find out more about which Revolut entity you receive services from, or if you have any other questions, please reach out to us via the in-app chat in the Revolut app. Revolut Ltd (No. 08804411) is authorised by the Financial Conduct Authority under the Electronic Money Regulations 2011 (Firm Reference 900562). Registered address: 30 South Colonnade, Canary Wharf, London, England, E14 5HX. Insurance related-products are arranged by Revolut Travel Ltd which is authorised by the Financial Conduct Authority to undertake insurance distribution activities (FCA No: 780586) and by Revolut Ltd, an Appointed Representative of Revolut Travel Ltd in relation to insurance distribution activities. Trading and investment products are provided by Revolut Trading Ltd (No. 832790) is wholly owned subsidiary of Revolut Ltd and is an appointed representative of Resolution Compliance Ltd which is authorised and regulated by the Financial Conduct Authority."}],"$L6f","$L70"]]}]]}]}] 10:["$","p","p-3",{"children":["The example demonstrates how to model seat-based pricing on a single plan. Each ",["$","strong","strong-0",{"children":"variation"}]," is one way to buy the same £15.00 seat: the packs fix the count on a ",["$","code","code-0",{"children":"flat"}]," item, while the flexible option leaves the count to you and bills the seats you report. Map your own pricing the same way - every seat arrangement becomes a variation, and each customer subscribes to exactly one of them."]}] 11:["$","div","inlinealert-0",{"data-type":"tip","className":"_25vm6y0","children":[["$","div",null,{"className":"_25vm6y1","children":["$","$L71",null,{"name":"Lightbulb","color":"var(--rui-color-success)","inline":true}]}],["$","div",null,{"className":"_25vm6y2","children":"Combining pricing models"}],["$","div",null,{"className":"_25vm6y3","children":["$","p","p-0",{"children":["Items can share a phase - a per-seat item alongside a flat platform fee, for example. For the rules, see ",["$","$L72","a-0",{"use":"$2","to":"/docs/guides/merchant/billing-subscriptions/subscription-plans","children":"Subscription plans"}],"."]}]}]]}] 12:["$","h2","h2-0",{"id":"how-it-works","children":["How it works",["$","$L73",null,{"id":"how-it-works"}]]}] 13:["$","p","p-4",{"children":["This guide walks the full flow: all API calls run between your backend and the Merchant API, and only ",["$","a","a-0",{"href":"#3-collect-first-payment","children":"step 3"}]," - collecting the first payment - reaches the customer's browser."]}] 14:["$","ol","ol-0",{"children":["\n",["$","li","li-0",{"children":[["$","strong","strong-0",{"children":"Create a per-seat plan"}]," - model the seat price as items on variations: static seat packs carry a ",["$","code","code-0",{"children":"flat"}]," item with a ",["$","code","code-1",{"children":"quantity"}],", and the dynamic option carries a ",["$","code","code-2",{"children":"usage"}]," item with ",["$","code","code-3",{"children":"latest"}]," aggregation."]}],"\n",["$","li","li-1",{"children":[["$","strong","strong-0",{"children":"Subscribe the customer"}]," - create the subscription, which starts in ",["$","code","code-0",{"children":"pending"}]," state until the first payment is collected."]}],"\n",["$","li","li-2",{"children":[["$","strong","strong-0",{"children":"Collect the first payment"}]," - retrieve the setup order, hand the customer a payment widget or Revolut's Hosted Checkout Page, and confirm the subscription is ",["$","code","code-0",{"children":"active"}]," - Revolut bills automatically from there."]}],"\n",["$","li","li-3",{"children":[["$","strong","strong-0",{"children":"Operate the subscription"}]," - report the seat count on the dynamic path, switch seat packs on the static paths, retrieve the billing cycles as they accrue, and cancel the subscription when the customer leaves."]}],"\n"]}] 15:["$","p","p-5",{"children":"The two seat shapes differ in how seat counts are handled for the life of the subscription:"}] 16:["$","div","table-0",{"className":"eowryt0","children":["$","table",null,{"className":"eowryt1","children":[["$","thead","thead-0",{"children":["$","tr","tr-0",{"children":[["$","th","th-0",{"className":"eowryt6","ref":"$undefined"}],["$","th","th-1",{"children":"Static seats","className":"eowryt6","ref":"$undefined"}],["$","th","th-2",{"children":"Dynamic seats","className":"eowryt6","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}],"className":"eowryt2","ref":"$undefined"}],["$","tbody","tbody-0",{"children":[["$","tr","tr-0",{"children":[["$","td","td-0",{"children":"Plan configuration","className":"eowryt7","ref":"$undefined"}],["$","td","td-1",{"children":[["$","code","code-0",{"children":"flat"}]," item with ",["$","code","code-1",{"children":"quantity: N"}]],"className":"eowryt7","ref":"$undefined"}],["$","td","td-2",{"children":[["$","code","code-0",{"children":"usage"}]," item with ",["$","code","code-1",{"children":"usage_aggregation_method: latest"}]],"className":"eowryt7","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}],["$","tr","tr-1",{"children":[["$","td","td-0",{"children":"Charge each cycle","className":"eowryt7","ref":"$undefined"}],["$","td","td-1",{"children":["Unit ",["$","code","code-0",{"children":"amount * quantity"}]],"className":"eowryt7","ref":"$undefined"}],["$","td","td-2",{"children":["Unit ",["$","code","code-0",{"children":"amount"}]," * most recently reported count"],"className":"eowryt7","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}],["$","tr","tr-2",{"children":[["$","td","td-0",{"children":"Seat changes","className":"eowryt7","ref":"$undefined"}],["$","td","td-1",{"children":["Switch to another variation, scheduled ",["$","code","code-0",{"children":"at_cycle_end"}]],"className":"eowryt7","ref":"$undefined"}],["$","td","td-2",{"children":"Report the new count via the usage API","className":"eowryt7","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}],["$","tr","tr-3",{"children":[["$","td","td-0",{"children":"Unreported cycle","className":"eowryt7","ref":"$undefined"}],["$","td","td-1",{"children":["N/A - always bills the plan ",["$","code","code-0",{"children":"quantity"}]],"className":"eowryt7","ref":"$undefined"}],["$","td","td-2",{"children":["Charges ",["$","code","code-0",{"children":"0"}]," - reported values don't carry over"],"className":"eowryt7","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}],["$","tr","tr-4",{"children":[["$","td","td-0",{"children":"Best for","className":"eowryt7","ref":"$undefined"}],["$","td","td-1",{"children":"Stable team sizes, predictable invoices","className":"eowryt7","ref":"$undefined"}],["$","td","td-2",{"children":"Growing teams, monthly seat true-ups","className":"eowryt7","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}]],"className":"eowryt3","ref":"$undefined"}]]}]}] 17:["$","p","p-6",{"children":"The Team plan you'll build in this guide looks like this:"}] 19:["$","h3","h3-0",{"id":"before-you-begin","children":["Before you begin",["$","$L73",null,{"id":"before-you-begin"}]]}] 1a:["$","p","p-7",{"children":"Before you start, make sure you have the following:"}] 1b:["$","ul","ul-1",{"className":"contains-task-list","children":["\n",["$","li","li-0",{"className":"task-list-item","children":[["$","$L74","input-0",{"wrapper":{"use":"span"},"type":"checkbox"}]," You've completed ",["$","strong","strong-0",{"children":["$","$L72","a-0",{"use":"$2","to":"/docs/guides/merchant/billing-subscriptions/api/get-started","children":"Get started with the Subscriptions API"}]}]," - it introduces the universal subscription flow this guide builds on"]}],"\n",["$","li","li-1",{"className":"task-list-item","children":[["$","$L74","input-0",{"wrapper":{"use":"span"},"type":"checkbox"}]," An ",["$","strong","strong-0",{"children":"existing customer"}]," - see ",["$","$L72","a-0",{"use":"$2","to":"/docs/api/merchant#create-customer","children":"Create a customer"}]]}],"\n",["$","li","li-2",{"className":"task-list-item","children":[["$","$L74","input-0",{"wrapper":{"use":"span"},"type":"checkbox"}]," Familiarity with the ",["$","strong","strong-0",{"children":"core subscription concepts"}]," - see ",["$","$L72","a-0",{"use":"$2","to":"/docs/guides/merchant/billing-subscriptions/subscription-plans","children":"Subscription plans"}]," and ",["$","$L72","a-1",{"use":"$2","to":"/docs/guides/merchant/billing-subscriptions/subscription-lifecycle","children":"Subscription lifecycle"}]]}],"\n"]}] 1c:["$","hr","hr-0",{}] 1d:["$","h2","h2-1",{"id":"implement-per-seat-subscription","children":["Implement per-seat subscription",["$","$L73",null,{"id":"implement-per-seat-subscription"}]]}] 1e:["$","p","p-8",{"children":["The steps below follow the Team plan narrative: you create the plan with its three variations, subscribe a customer to the 5-seat pack, collect the first payment, and confirm the subscription is ",["$","code","code-0",{"children":"active"}],"."]}] 1f:["$","h3","h3-1",{"id":"1-create-plan-for-per-seat-pricing","children":["1. Create plan for per-seat pricing",["$","$L73",null,{"id":"1-create-plan-for-per-seat-pricing"}]]}] 20:["$","p","p-9",{"children":["Your Team plan sells the same £15.00 seat in three variations. Each variation is a single phase, and the seat price lives on an item in the phase: the seat packs carry a ",["$","code","code-0",{"children":"flat"}]," item with the count fixed in ",["$","code","code-1",{"children":"quantity"}],", and the flexible variation carries a ",["$","code","code-2",{"children":"usage"}]," item that bills whatever count you report."]}] 21:["$","div","inlinealert-1",{"data-type":"info","className":"_25vm6y0","children":[["$","div",null,{"className":"_25vm6y1","children":["$","$L71",null,{"name":"ExclamationMarkOutline","color":"var(--rui-color-accent)","inline":true}]}],null,["$","div",null,{"className":"_25vm6y3","children":["$","p","p-0",{"children":["For the plan, variation, and phase hierarchy these items sit in, see ",["$","$L72","a-0",{"use":"$2","to":"/docs/guides/merchant/billing-subscriptions/api/get-started","children":"Get started with the subscriptions API"}],"."]}]}]]}] 22:["$","p","p-10",{"children":["Call ",["$","$L72","a-0",{"use":"$2","to":"/docs/api/merchant#create-subscription-plan","children":"Create a subscription plan"}],", turning your seat pricing into a plan your customers can subscribe to:"]}] 23:["$","$L75","tabs-0",{"children":["\n",["$","$L76","tabitem-0",{"label":"Request","children":["\n","$L77","\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",["$","div","table-0",{"className":"eowryt0","children":["$","table",null,{"className":"eowryt1","children":[["$","thead","thead-0",{"children":["$","tr","tr-0",{"children":[["$","th","th-0",{"children":"Parameter","className":"eowryt6","ref":"$undefined"}],["$","th","th-1",{"children":"Description","className":"eowryt6","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}],"className":"eowryt2","ref":"$undefined"}],["$","tbody","tbody-0",{"children":[["$","tr","tr-0",{"children":[["$","td","td-0",{"children":["$","code","code-0",{"children":"name"}],"className":"eowryt7","ref":"$undefined"}],["$","td","td-1",{"children":"The plan name - what your customers subscribe to","className":"eowryt7","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}],["$","tr","tr-1",{"children":[["$","td","td-0",{"children":["$","code","code-0",{"children":"variations"}],"className":"eowryt7","ref":"$undefined"}],["$","td","td-1",{"children":"Purchasing options for the plan - here, two seat packs and the flexible option","className":"eowryt7","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}],["$","tr","tr-2",{"children":[["$","td","td-0",{"children":["$","code","code-0",{"children":"phases"}],"className":"eowryt7","ref":"$undefined"}],["$","td","td-1",{"children":["Sequential pricing stages within a variation, executed in ",["$","code","code-0",{"children":"ordinal"}]," order"],"className":"eowryt7","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}],["$","tr","tr-3",{"children":[["$","td","td-0",{"children":["$","code","code-0",{"children":"ordinal"}],"className":"eowryt7","ref":"$undefined"}],["$","td","td-1",{"children":["Execution order of the phase, starting at ",["$","code","code-0",{"children":"1"}]],"className":"eowryt7","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}],["$","tr","tr-4",{"children":[["$","td","td-0",{"children":["$","code","code-0",{"children":"cycle_duration"}],"className":"eowryt7","ref":"$undefined"}],["$","td","td-1",{"children":["Length of the billing cycle, as an ",["$","a","a-0",{"href":"https://en.wikipedia.org/wiki/ISO_8601","target":"_blank","rel":"noreferrer","children":"ISO 8601"}]," duration, e.g., ",["$","code","code-0",{"children":"P1M"}]],"className":"eowryt7","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}],["$","tr","tr-5",{"children":[["$","td","td-0",{"children":["$","code","code-0",{"children":"amount"}],"className":"eowryt7","ref":"$undefined"}],["$","td","td-1",{"children":["Price per billing cycle, in minor units - ",["$","code","code-0",{"children":"7500"}]," is £75.00, ",["$","code","code-1",{"children":"15000"}]," is £150.00"],"className":"eowryt7","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}],["$","tr","tr-6",{"children":[["$","td","td-0",{"children":["$","code","code-0",{"children":"currency"}],"className":"eowryt7","ref":"$undefined"}],["$","td","td-1",{"children":["Billing currency, as an ",["$","a","a-0",{"href":"https://en.wikipedia.org/wiki/ISO_4217","target":"_blank","rel":"noreferrer","children":"ISO 4217"}]," code"],"className":"eowryt7","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}],["$","tr","tr-7",{"children":[["$","td","td-0",{"children":["$","code","code-0",{"children":"subscription_items"}],"className":"eowryt7","ref":"$undefined"}],["$","td","td-1",{"children":"The seat price as items on the phase - here, one item per variation","className":"eowryt7","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}],["$","tr","tr-8",{"children":[["$","td","td-0",{"children":["$","code","code-0",{"children":"subscription_items[].type"}],"className":"eowryt7","ref":"$undefined"}],["$","td","td-1",{"children":[["$","code","code-0",{"children":"flat"}]," bills a fixed ",["$","code","code-1",{"children":"quantity"}]," every cycle; ",["$","code","code-2",{"children":"usage"}]," bills a count you report"],"className":"eowryt7","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}],["$","tr","tr-9",{"children":[["$","td","td-0",{"children":["$","code","code-0",{"children":"subscription_items[].quantity"}],"className":"eowryt7","ref":"$undefined"}],["$","td","td-1",{"children":["Seat count on a ",["$","code","code-0",{"children":"flat"}]," item - each cycle charges ",["$","code","code-1",{"children":"amount * quantity"}]],"className":"eowryt7","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}],["$","tr","tr-10",{"children":[["$","td","td-0",{"children":["$","code","code-0",{"children":"subscription_items[].unit"}],"className":"eowryt7","ref":"$undefined"}],["$","td","td-1",{"children":["What the item bills - a free-form label, ",["$","code","code-0",{"children":"seat"}]," here"],"className":"eowryt7","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}],["$","tr","tr-11",{"children":[["$","td","td-0",{"children":["$","code","code-0",{"children":"subscription_items[].package_size"}],"className":"eowryt7","ref":"$undefined"}],"$L78"],"className":"eowryt5","ref":"$undefined"}],"$L79","$L7a","$L7b"],"className":"eowryt3","ref":"$undefined"}]]}]}],"\n"]}],"\n","$L7c","\n"]}] 24:["$","h3","h3-2",{"id":"2-subscribe-customer","children":["2. Subscribe customer",["$","$L73",null,{"id":"2-subscribe-customer"}]]}] 25:["$","p","p-11",{"children":["When a customer wants to subscribe to your ",["$","strong","strong-0",{"children":"Team plan"}],", you create a subscription. The subscription connects the customer - and their consent to use their payment details for recurring charges - to the variation they chose: the 5-seat variation in this walkthrough."]}] 26:["$","p","p-12",{"children":["Subscription creation is the same for every pricing model - the pricing lives entirely in the plan you built. Once created, the subscription starts in ",["$","code","code-0",{"children":"pending"}]," state - it becomes ",["$","code","code-1",{"children":"active"}]," once the customer completes the first payment."]}] 27:["$","p","p-13",{"children":["Call ",["$","$L72","a-0",{"use":"$2","to":"/docs/api/merchant#create-subscription","children":"Create a subscription"}]," with an idempotency key, so you can safely retry the request without creating duplicate subscriptions:"]}] 28:["$","$L75","tabs-1",{"children":["\n",["$","$L76","tabitem-0",{"label":"Request","children":["\n","$L7d","\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",["$","div","table-0",{"className":"eowryt0","children":["$","table",null,{"className":"eowryt1","children":[["$","thead","thead-0",{"children":["$","tr","tr-0",{"children":[["$","th","th-0",{"children":"Parameter","className":"eowryt6","ref":"$undefined"}],["$","th","th-1",{"children":"Description","className":"eowryt6","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}],"className":"eowryt2","ref":"$undefined"}],["$","tbody","tbody-0",{"children":[["$","tr","tr-0",{"children":[["$","td","td-0",{"children":["$","code","code-0",{"children":"plan_variation_id"}],"className":"eowryt7","ref":"$undefined"}],["$","td","td-1",{"children":["The variation the customer subscribes to - the 5-seat variation ",["$","code","code-0",{"children":"id"}]," you saved in ",["$","a","a-0",{"href":"#1-create-plan-for-per-seat-pricing","children":"step 1"}]],"className":"eowryt7","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}],["$","tr","tr-1",{"children":[["$","td","td-0",{"children":["$","code","code-0",{"children":"customer_id"}],"className":"eowryt7","ref":"$undefined"}],["$","td","td-1",{"children":"The customer to bill","className":"eowryt7","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}],["$","tr","tr-2",{"children":[["$","td","td-0",{"children":["$","code","code-0",{"children":"external_reference"}],"className":"eowryt7","ref":"$undefined"}],["$","td","td-1",{"children":"Optional: your own identifier for the subscription, e.g., the customer's ID in your system - returned in responses and echoed in webhook events","className":"eowryt7","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}],["$","tr","tr-3",{"children":[["$","td","td-0",{"children":["$","code","code-0",{"children":"setup_order_redirect_url"}],"className":"eowryt7","ref":"$undefined"}],["$","td","td-1",{"children":"Optional: where the customer lands after completing payment on the hosted checkout page","className":"eowryt7","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}]],"className":"eowryt3","ref":"$undefined"}]]}]}],"\n"]}],"\n",["$","$L76","tabitem-1",{"label":"Response","children":["\n",["$","p","p-0",{"children":["The subscription is created in ",["$","code","code-0",{"children":"pending"}]," state. Save the ",["$","code","code-1",{"children":"setup_order_id"}]," - ",["$","a","a-0",{"href":"#3-collect-first-payment","children":"step 3"}]," collects the first payment with it - and the subscription ",["$","code","code-2",{"children":"id"}]," - ",["$","a","a-1",{"href":"#4-verify-subscription-state","children":"step 4"}]," confirms activation with it, and the ",["$","a","a-2",{"href":"#operate-per-seat-subscription","children":"Operate section"}]," uses it for seat adjustments, billing cycles, and cancellation."]}],"\n","$L7e","\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",["$","div","table-0",{"className":"eowryt0","children":["$","table",null,{"className":"eowryt1","children":[["$","thead","thead-0",{"children":["$","tr","tr-0",{"children":[["$","th","th-0",{"children":"Parameter","className":"eowryt6","ref":"$undefined"}],["$","th","th-1",{"children":"Description","className":"eowryt6","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}],"className":"eowryt2","ref":"$undefined"}],["$","tbody","tbody-0",{"children":[["$","tr","tr-0",{"children":[["$","td","td-0",{"children":["$","code","code-0",{"children":"id"}],"className":"eowryt7","ref":"$undefined"}],["$","td","td-1",{"children":"The subscription ID - used to adjust seats, retrieve the billing cycles, and cancel the subscription","className":"eowryt7","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}],["$","tr","tr-1",{"children":[["$","td","td-0",{"children":["$","code","code-0",{"children":"state"}],"className":"eowryt7","ref":"$undefined"}],["$","td","td-1",{"children":[["$","code","code-0",{"children":"pending"}]," - the subscription becomes ",["$","code","code-1",{"children":"active"}]," once the customer completes the first payment"],"className":"eowryt7","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}],["$","tr","tr-2",{"children":[["$","td","td-0",{"children":["$","code","code-0",{"children":"setup_order_id"}],"className":"eowryt7","ref":"$undefined"}],["$","td","td-1",{"children":["The setup order collecting the first payment - ",["$","a","a-0",{"href":"#3-collect-first-payment","children":"step 3"}]," retrieves the order with it"],"className":"eowryt7","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}],["$","tr","tr-3",{"children":[["$","td","td-0",{"children":["$","code","code-0",{"children":"current_cycle_id"}],"className":"eowryt7","ref":"$undefined"}],["$","td","td-1",{"children":["The cycle currently billing the subscription - retrieve it for entitlement checks in ","$L7f"],"className":"eowryt7","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}]],"className":"eowryt3","ref":"$undefined"}]]}]}],"\n"]}],"\n"]}] 29:["$","div","inlinealert-2",{"data-type":"tip","className":"_25vm6y0","children":[["$","div",null,{"className":"_25vm6y1","children":["$","$L71",null,{"name":"Lightbulb","color":"var(--rui-color-success)","inline":true}]}],["$","div",null,{"className":"_25vm6y2","children":"First-cycle charges differ by shape"}],["$","div",null,{"className":"_25vm6y3","children":["$","p","p-0",{"children":"On the static paths, the first payment covers the first cycle's full seat charge - £75.00 here. On the dynamic path, the first payment is collected before any seat count is reported - the usage item contributes nothing until you report usage, so make sure your first report lands inside the cycle."}]}]]}] 2a:["$","h3","h3-3",{"id":"3-collect-first-payment","children":["3. Collect first payment",["$","$L73",null,{"id":"3-collect-first-payment"}]]}] 2b:["$","p","p-14",{"children":["In ",["$","a","a-0",{"href":"#2-subscribe-customer","children":"step 2"}]," you created the subscription. It is in ",["$","code","code-0",{"children":"pending"}]," state, and becomes ",["$","code","code-1",{"children":"active"}]," once the customer completes the first payment. That payment is collected through a ",["$","strong","strong-0",{"children":"setup order"}]," - an order that exists to start a subscription."]}] 2c:["$","p","p-15",{"children":["Revolut creates the setup order in the background when you create the subscription: it takes the first charge - £75.00 for the 5-seat variation - and saves the customer's payment method for the recurring cycles that follow. You already saved its ",["$","code","code-0",{"children":"setup_order_id"}],"."]}] 2d:["$","h4","h4-0",{"id":"3-1-retrieve-setup-order","children":["3.1 Retrieve setup order",["$","$L73",null,{"id":"3-1-retrieve-setup-order"}]]}] 2e:["$","p","p-16",{"children":["Retrieve the setup order with ",["$","$L72","a-0",{"use":"$2","to":"/docs/api/merchant#retrieve-order","children":"Retrieve an order"}],", passing the ",["$","code","code-0",{"children":"setup_order_id"}]," you saved in ",["$","a","a-1",{"href":"#2-subscribe-customer","children":"step 2"}]," as the ",["$","code","code-1",{"children":"order_id"}],":"]}] 2f:["$","$L75","tabs-2",{"children":["\n",["$","$L76","tabitem-0",{"label":"Request","children":["\n","$L80","\n\n\n\n\n\n\n\n\n\n\n\n\n\n",["$","div","table-0",{"className":"eowryt0","children":["$","table",null,{"className":"eowryt1","children":[["$","thead","thead-0",{"children":["$","tr","tr-0",{"children":[["$","th","th-0",{"children":"Parameter","className":"eowryt6","ref":"$undefined"}],["$","th","th-1",{"children":"Description","className":"eowryt6","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}],"className":"eowryt2","ref":"$undefined"}],["$","tbody","tbody-0",{"children":["$","tr","tr-0",{"children":[["$","td","td-0",{"children":["$","code","code-0",{"children":"order_id"}],"className":"eowryt7","ref":"$undefined"}],["$","td","td-1",{"children":["The ID of the setup order you saved in ",["$","a","a-0",{"href":"#2-subscribe-customer","children":"step 2"}]],"className":"eowryt7","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}],"className":"eowryt3","ref":"$undefined"}]]}]}],"\n"]}],"\n",["$","$L76","tabitem-1",{"label":"Response","children":["\n",["$","p","p-0",{"children":["The response returns the setup order. The fields that unlock the checkout approaches below are - ",["$","code","code-0",{"children":"token"}]," for embedding a payment widget on your site and ",["$","code","code-1",{"children":"checkout_url"}]," for Revolut's Hosted Checkout Page."]}],"\n","$L81","\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",["$","div","table-0",{"className":"eowryt0","children":["$","table",null,{"className":"eowryt1","children":[["$","thead","thead-0",{"children":["$","tr","tr-0",{"children":[["$","th","th-0",{"children":"Parameter","className":"eowryt6","ref":"$undefined"}],["$","th","th-1",{"children":"Description","className":"eowryt6","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}],"className":"eowryt2","ref":"$undefined"}],["$","tbody","tbody-0",{"children":[["$","tr","tr-0",{"children":[["$","td","td-0",{"children":["$","code","code-0",{"children":"token"}],"className":"eowryt7","ref":"$undefined"}],["$","td","td-1",{"children":"The public token for initialising a payment widget","className":"eowryt7","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}],["$","tr","tr-1",{"children":[["$","td","td-0",{"children":["$","code","code-0",{"children":"state"}],"className":"eowryt7","ref":"$undefined"}],["$","td","td-1",{"children":[["$","code","code-0",{"children":"pending"}]," - the order completes once the customer pays the £75.00 first charge"],"className":"eowryt7","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}],["$","tr","tr-2",{"children":[["$","td","td-0",{"children":["$","code","code-0",{"children":"checkout_url"}],"className":"eowryt7","ref":"$undefined"}],["$","td","td-1",{"children":"The link to Revolut's Hosted Checkout Page","className":"eowryt7","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}]],"className":"eowryt3","ref":"$undefined"}]]}]}],"\n"]}],"\n"]}] 30:["$","p","p-17",{"children":"Like the calls in the previous steps, this is a server-side operation - it happens between your backend and the Merchant API."}] 31:["$","h4","h4-1",{"id":"3-2-build-your-payment-acceptance-solution","children":["3.2 Build your payment acceptance solution",["$","$L73",null,{"id":"3-2-build-your-payment-acceptance-solution"}]]}] 32:["$","p","p-18",{"children":"Collecting the payment reaches beyond your backend: the customer pays in their browser or mobile app, so this part of the flow has client-side work alongside your server. The goal is to hand the customer a way to pay the first charge and save their payment method. Revolut supports two approaches, and both do this for you:"}] 33:["$","div","linkcardgrid-0",{"className":"quhugq0","children":["\n",["$","div","linkcard-0",{"className":"quhugq1","children":[["$","$L82",null,{"useIcon":"CodeRepository"}],["$","div",null,{"data-has-icon":true,"className":"quhugq4","children":[["$","a",null,{"className":"quhugq5","href":"#","children":"Payment widget"}],["$","div",null,{"className":"quhugq6","children":"Embed the payment flow in your site: you build the customer experience, and the customer never leaves your page"}]]}]]}],"\n",["$","div","linkcard-1",{"className":"quhugq1","children":[["$","$L82",null,{"useIcon":"Browser"}],["$","div",null,{"data-has-icon":true,"className":"quhugq4","children":[["$","a",null,{"className":"quhugq5","href":"#","children":"Hosted Checkout Page"}],["$","div",null,{"className":"quhugq6","children":"Redirect to a payment page Revolut hosts for you: no payment UI to build, and Revolut handles the payment experience"}]]}]]}],"\n"]}] 34:["$","p","p-19",{"children":"Choose the approach that fits your integration:"}] 35:["$","$L75","tabs-3",{"children":["\n",["$","$L76","tabitem-0",{"label":"Payment widget","children":["\n",["$","p","p-0",{"children":"Keep the customer on your site with an embedded payment widget or a card-not-present method:"}],"\n",["$","ol","ol-0",{"children":["\n",["$","li","li-0",{"children":["Build your payment acceptance solution on your frontend with the widget or payment method of your choice, initialising it with the ",["$","code","code-0",{"children":"token"}]," from the response."]}],"\n",["$","li","li-1",{"children":"Configure it to save the customer's payment method for merchant-initiated recurring transactions."}],"\n",["$","li","li-2",{"children":"The customer completes payment without leaving your site, and Revolut saves their payment method."}],"\n"]}],"\n"]}],"\n",["$","$L76","tabitem-1",{"label":"Hosted Checkout Page","children":["\n",["$","p","p-0",{"children":"Redirect the customer to Revolut's Hosted Checkout Page:"}],"\n",["$","ol","ol-0",{"children":["\n",["$","li","li-0",{"children":["Redirect the customer to the ",["$","code","code-0",{"children":"checkout_url"}]," from the response."]}],"\n",["$","li","li-1",{"children":"The customer completes payment on the hosted page, and Revolut saves their payment method."}],"\n",["$","li","li-2",{"children":["If you set ",["$","code","code-0",{"children":"setup_order_redirect_url"}]," in ",["$","a","a-0",{"href":"#2-subscribe-customer","children":"step 2"}],", the customer is redirected there after payment; otherwise they see Revolut's default completion screen."]}],"\n"]}],"\n"]}],"\n"]}] 36:["$","div","inlinealert-3",{"data-type":"info","className":"_25vm6y0","children":[["$","div",null,{"className":"_25vm6y1","children":["$","$L71",null,{"name":"ExclamationMarkOutline","color":"var(--rui-color-accent)","inline":true}]}],null,["$","div",null,{"className":"_25vm6y3","children":["$","p","p-0",{"children":["This step assumes you're familiar with a standard payment method integration, see ",["$","$L72","a-0",{"use":"$2","to":"/docs/guides/merchant/accept-payments/online-payments/introduction","children":"Introduction to online payments"}],"."]}]}]]}] 37:["$","h3","h3-4",{"id":"4-verify-subscription-state","children":["4. Verify subscription state",["$","$L73",null,{"id":"4-verify-subscription-state"}]]}] 38:["$","p","p-20",{"children":["When the customer completes the first payment in ",["$","a","a-0",{"href":"#3-collect-first-payment","children":"step 3"}],", the subscription becomes ",["$","code","code-0",{"children":"active"}],". There's no webhook event for activation, so retrieve the subscription to confirm it's live."]}] 39:["$","p","p-21",{"children":["Check the subscription details with ",["$","$L72","a-0",{"use":"$2","to":"/docs/api/merchant#retrieve-subscription","children":"Retrieve a subscription"}],", passing the subscription ",["$","code","code-0",{"children":"id"}]," from ",["$","a","a-1",{"href":"#2-subscribe-customer","children":"step 2"}]," in the request path:"]}] 3a:["$","$L75","tabs-4",{"children":["\n",["$","$L76","tabitem-0",{"label":"Request","children":["\n","$L83","\n\n\n\n\n\n\n\n\n\n\n\n\n\n",["$","div","table-0",{"className":"eowryt0","children":["$","table",null,{"className":"eowryt1","children":[["$","thead","thead-0",{"children":["$","tr","tr-0",{"children":[["$","th","th-0",{"children":"Parameter","className":"eowryt6","ref":"$undefined"}],["$","th","th-1",{"children":"Description","className":"eowryt6","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}],"className":"eowryt2","ref":"$undefined"}],["$","tbody","tbody-0",{"children":["$","tr","tr-0",{"children":[["$","td","td-0",{"children":["$","code","code-0",{"children":"subscription_id"}],"className":"eowryt7","ref":"$undefined"}],["$","td","td-1",{"children":["The ID of the subscription you saved in ",["$","a","a-0",{"href":"#2-subscribe-customer","children":"step 2"}]],"className":"eowryt7","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}],"className":"eowryt3","ref":"$undefined"}]]}]}],"\n"]}],"\n",["$","$L76","tabitem-1",{"label":"Response","children":["\n",["$","p","p-0",{"children":["When the first payment succeeds, the subscription moves to ",["$","code","code-0",{"children":"active"}]," with a saved ",["$","code","code-1",{"children":"payment_method_id"}]," and a ",["$","code","code-2",{"children":"start_date"}],"."]}],"\n","$L84","\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",["$","div","table-0",{"className":"eowryt0","children":["$","table",null,{"className":"eowryt1","children":[["$","thead","thead-0",{"children":["$","tr","tr-0",{"children":[["$","th","th-0",{"children":"Parameter","className":"eowryt6","ref":"$undefined"}],["$","th","th-1",{"children":"Description","className":"eowryt6","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}],"className":"eowryt2","ref":"$undefined"}],["$","tbody","tbody-0",{"children":[["$","tr","tr-0",{"children":[["$","td","td-0",{"children":["$","code","code-0",{"children":"state"}],"className":"eowryt7","ref":"$undefined"}],["$","td","td-1",{"children":[["$","code","code-0",{"children":"active"}]," - the subscription is live and charges on each billing cycle"],"className":"eowryt7","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}],["$","tr","tr-1",{"children":[["$","td","td-0",{"children":["$","code","code-0",{"children":"payment_method_id"}],"className":"eowryt7","ref":"$undefined"}],["$","td","td-1",{"children":"The saved payment method - Revolut charges it automatically on each cycle","className":"eowryt7","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}],["$","tr","tr-2",{"children":[["$","td","td-0",{"children":["$","code","code-0",{"children":"start_date"}],"className":"eowryt7","ref":"$undefined"}],["$","td","td-1",{"children":["When the subscription became ",["$","code","code-0",{"children":"active"}]],"className":"eowryt7","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}],["$","tr","tr-3",{"children":[["$","td","td-0",{"children":["$","code","code-0",{"children":"current_cycle_id"}],"className":"eowryt7","ref":"$undefined"}],["$","td","td-1",{"children":["The cycle currently billing the subscription - ",["$","a","a-0",{"href":"#retrieve-billing-cycles","children":"Retrieve billing cycles"}]," uses it"],"className":"eowryt7","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}]],"className":"eowryt3","ref":"$undefined"}]]}]}],"\n"]}],"\n"]}] 3b:["$","p","p-22",{"children":["Once the subscription is ",["$","code","code-0",{"children":"active"}],", your per-seat subscription is live, and Revolut takes over from here. We charge the customer's saved payment method the seat charge of the subscribed variation - £75.00 a month on the 5-seat pack. Failed payments are retried automatically - see ",["$","$L72","a-0",{"use":"$2","to":"/docs/guides/merchant/billing-subscriptions/subscription-lifecycle#failed-payments-and-retries","children":"Failed payments and retries"}],"."]}] 3c:["$","div","inlinealert-4",{"data-type":"tip","className":"_25vm6y0","children":[["$","div",null,{"className":"_25vm6y1","children":["$","$L71",null,{"name":"Lightbulb","color":"var(--rui-color-success)","inline":true}]}],null,["$","div",null,{"className":"_25vm6y3","children":["$","p","p-0",{"children":[["$","strong","strong-0",{"children":"You've completed the per-seat subscription flow!"}]," The Team plan is live with its three variations, and Revolut bills the customer automatically from here. Next, operate the subscription: report or change the seat count as the team evolves, retrieve the billing cycles as they accrue, and cancel it when the customer leaves."]}]}]]}] 3d:["$","hr","hr-1",{}] 3e:["$","h2","h2-2",{"id":"operate-per-seat-subscription","children":["Operate per-seat subscription",["$","$L73",null,{"id":"operate-per-seat-subscription"}]]}] 3f:["$","p","p-23",{"children":"With the subscription active, Revolut bills the saved payment method automatically. What remains yours while it runs depends on the shape the customer chose."}] 40:["$","p","p-24",{"children":"On the dynamic path, you keep the reported seat count current; on the static paths, you move the customer between seat packs. On every path, you also retrieve the billing cycles - for entitlement checks, billing history, and reconciliation - and cancel the subscription when the customer leaves."}] 41:["$","h3","h3-5",{"id":"adjust-seat-count","children":["Adjust seat count",["$","$L73",null,{"id":"adjust-seat-count"}]]}] 42:["$","p","p-25",{"children":"Seat counts change as teams grow and shrink. How you keep the billed count current depends on the shape the customer subscribed to - report it on the dynamic path, switch seat packs on the static paths."}] 43:["$","h4","h4-2",{"id":"report-seat-count","children":["Report seat count",["$","$L73",null,{"id":"report-seat-count"}]]}] 44:["$","p","p-26",{"children":"On the dynamic path, reporting seat count is a recurring operation: whenever the customer's team changes size - seats added, seats removed - report the current count, and Revolut charges the latest value at each cycle's end. The example below follows a subscription on the flexible variation, with the customer's team at 12 seats."}] 45:["$","div","inlinealert-5",{"data-type":"warning","className":"_25vm6y0","children":[["$","div",null,{"className":"_25vm6y1","children":["$","$L71",null,{"name":"ExclamationMark","color":"var(--rui-color-warning)","inline":true}]}],null,["$","div",null,{"className":"_25vm6y3","children":["$","p","p-0",{"children":["The ",["$","code","code-0",{"children":"Idempotency-Key"}]," header is ",["$","strong","strong-0",{"children":"required"}]," for this endpoint - it prevents retries from creating duplicate usage records."]}]}]]}] 46:["$","p","p-27",{"children":["Call ",["$","$L72","a-0",{"use":"$2","to":"/docs/api/merchant#create-subscription-usage","children":"Create a subscription usage"}],", passing the subscription ",["$","code","code-0",{"children":"id"}]," and the ",["$","code","code-1",{"children":"subscription_item_code"}]," you configured in ",["$","a","a-1",{"href":"#1-create-plan-for-per-seat-pricing","children":"step 1"}],", to tell Revolut the seat count to bill at the cycle's end:"]}] 47:["$","$L75","tabs-5",{"children":["\n",["$","$L76","tabitem-0",{"label":"Request","children":["\n","$L85","\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",["$","div","table-0",{"className":"eowryt0","children":["$","table",null,{"className":"eowryt1","children":[["$","thead","thead-0",{"children":["$","tr","tr-0",{"children":[["$","th","th-0",{"children":"Parameter","className":"eowryt6","ref":"$undefined"}],["$","th","th-1",{"children":"Description","className":"eowryt6","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}],"className":"eowryt2","ref":"$undefined"}],["$","tbody","tbody-0",{"children":[["$","tr","tr-0",{"children":[["$","td","td-0",{"children":["$","code","code-0",{"children":"subscription_id"}],"className":"eowryt7","ref":"$undefined"}],["$","td","td-1",{"children":"The ID of the subscription on the dynamic variation","className":"eowryt7","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}],["$","tr","tr-1",{"children":[["$","td","td-0",{"children":["$","code","code-0",{"children":"subscription_item_code"}],"className":"eowryt7","ref":"$undefined"}],["$","td","td-1",{"children":["The ",["$","code","code-0",{"children":"code"}]," you gave the usage item in ",["$","a","a-0",{"href":"#1-create-plan-for-per-seat-pricing","children":"step 1"}]," - here ",["$","code","code-1",{"children":"active_seats"}]],"className":"eowryt7","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}],["$","tr","tr-2",{"children":[["$","td","td-0",{"children":["$","code","code-0",{"children":"usage_date"}],"className":"eowryt7","ref":"$undefined"}],["$","td","td-1",{"children":"When the count applies - Revolut resolves the billing cycle from this date","className":"eowryt7","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}],["$","tr","tr-3",{"children":[["$","td","td-0",{"children":["$","code","code-0",{"children":"quantity"}],"className":"eowryt7","ref":"$undefined"}],["$","td","td-1",{"children":"The current seat count - a gauge, not a delta: report the total count, not the change","className":"eowryt7","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}]],"className":"eowryt3","ref":"$undefined"}]]}]}],"\n"]}],"\n",["$","$L76","tabitem-1",{"label":"Response","children":["\n",["$","p","p-0",{"children":"The response confirms the report and shows the billing cycle it's connected."}],"\n","$L86","\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",["$","div","table-0",{"className":"eowryt0","children":["$","table",null,{"className":"eowryt1","children":[["$","thead","thead-0",{"children":["$","tr","tr-0",{"children":[["$","th","th-0",{"children":"Parameter","className":"eowryt6","ref":"$undefined"}],["$","th","th-1",{"children":"Description","className":"eowryt6","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}],"className":"eowryt2","ref":"$undefined"}],["$","tbody","tbody-0",{"children":[["$","tr","tr-0",{"children":[["$","td","td-0",{"children":["$","code","code-0",{"children":"subscription_cycle_id"}],"className":"eowryt7","ref":"$undefined"}],["$","td","td-1",{"children":["The cycle the report landed in - Revolut identified it from ",["$","code","code-0",{"children":"usage_date"}]],"className":"eowryt7","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}],["$","tr","tr-1",{"children":[["$","td","td-0",{"children":["$","code","code-0",{"children":"quantity"}],"className":"eowryt7","ref":"$undefined"}],["$","td","td-1",{"children":"The seat count this cycle will bill - echoed back as reported","className":"eowryt7","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}]],"className":"eowryt3","ref":"$undefined"}]]}]}],"\n"]}],"\n"]}] 48:["$","p","p-28",{"children":"How reported counts become the cycle charge:"}] 49:["$","div","table-1",{"className":"eowryt0","children":["$","table",null,{"className":"eowryt1","children":[["$","thead","thead-0",{"children":["$","tr","tr-0",{"children":[["$","th","th-0",{"children":"Reporting scenario","className":"eowryt6","ref":"$undefined"}],["$","th","th-1",{"children":"What happens","className":"eowryt6","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}],"className":"eowryt2","ref":"$undefined"}],["$","tbody","tbody-0",{"children":[["$","tr","tr-0",{"children":[["$","td","td-0",{"children":"Report multiple times in a cycle","className":"eowryt7","ref":"$undefined"}],["$","td","td-1",{"children":"The most recent report at the cycle's cutoff date wins - report 5 seats, then 12, and the cycle bills 12 seats: 12 x £15.00 = £180.00","className":"eowryt7","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}],["$","tr","tr-1",{"children":[["$","td","td-0",{"children":"Report nothing during a cycle","className":"eowryt7","ref":"$undefined"}],["$","td","td-1",{"children":["The item charges ",["$","code","code-0",{"children":"0"}]," - values don't carry over, so if you stop reporting, billing stops"],"className":"eowryt7","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}],["$","tr","tr-2",{"children":[["$","td","td-0",{"children":"Correct a past cycle","className":"eowryt7","ref":"$undefined"}],["$","td","td-1",{"children":["Accepted until its ",["$","code","code-0",{"children":"usage_cutoff_date"}]," - 12 hours after ",["$","code","code-1",{"children":"end_date"}]," by default. Send a new report with a ",["$","code","code-2",{"children":"usage_date"}]," inside the cycle being corrected"],"className":"eowryt7","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}],["$","tr","tr-3",{"children":[["$","td","td-0",{"children":"Report ahead for the next cycle","className":"eowryt7","ref":"$undefined"}],["$","td","td-1",{"children":["Accepted and held in a ",["$","code","code-0",{"children":"pending"}]," cycle until that cycle starts"],"className":"eowryt7","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}]],"className":"eowryt3","ref":"$undefined"}]]}]}] 4a:["$","h4","h4-3",{"id":"change-seat-count","children":["Change seat count",["$","$L73",null,{"id":"change-seat-count"}]]}] 4b:["$","p","p-29",{"children":["On the static paths, the seat count is fixed on the plan's ",["$","code","code-0",{"children":"flat"}]," item - there's no mid-cycle quantity update. Instead, move the customer to a different seat pack: ",["$","$L72","a-0",{"use":"$2","to":"/docs/api/merchant#change-subscription-plan","children":"Change a subscription plan"}]," with the new variation's ",["$","code","code-1",{"children":"plan_variation_id"}],", scheduled to land at the end of the current cycle. The walkthrough customer grows into the 10-seat variation you created in ",["$","a","a-1",{"href":"#1-create-plan-for-per-seat-pricing","children":"step 1"}],":"]}] 4c:["$","$L75","tabs-6",{"children":["\n",["$","$L76","tabitem-0",{"label":"Request","children":["\n","$L87","\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",["$","div","table-0",{"className":"eowryt0","children":["$","table",null,{"className":"eowryt1","children":[["$","thead","thead-0",{"children":["$","tr","tr-0",{"children":[["$","th","th-0",{"children":"Parameter","className":"eowryt6","ref":"$undefined"}],["$","th","th-1",{"children":"Description","className":"eowryt6","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}],"className":"eowryt2","ref":"$undefined"}],["$","tbody","tbody-0",{"children":[["$","tr","tr-0",{"children":[["$","td","td-0",{"children":["$","code","code-0",{"children":"plan_variation_id"}],"className":"eowryt7","ref":"$undefined"}],["$","td","td-1",{"children":["The new seat pack - the 10-seat variation ",["$","code","code-0",{"children":"id"}]," you saved in ",["$","a","a-0",{"href":"#1-create-plan-for-per-seat-pricing","children":"step 1"}]],"className":"eowryt7","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}],["$","tr","tr-1",{"children":[["$","td","td-0",{"children":["$","code","code-0",{"children":"scheduled"}],"className":"eowryt7","ref":"$undefined"}],["$","td","td-1",{"children":["When the change takes effect - ",["$","code","code-0",{"children":"at_cycle_end"}]," completes the current cycle on the old pack first"],"className":"eowryt7","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}]],"className":"eowryt3","ref":"$undefined"}]]}]}],"\n"]}],"\n",["$","$L76","tabitem-1",{"label":"Response","children":["\n",["$","p","p-0",{"children":"The plan change is scheduled - the current cycle completes on the 5-seat pack."}],"\n","$L88","\n"]}],"\n"]}] 4d:["$","p","p-30",{"children":["The next cycle bills the new pack, with no proration in between: the customer moves from 5 seats (£75.00 a month) to 10 (£150.00 a month) at the cycle boundary. For a team size your plan doesn't model, create a plan with the right ",["$","code","code-0",{"children":"quantity"}]," first, then switch the subscription to it the same way."]}] 4e:["$","h3","h3-6",{"id":"retrieve-billing-cycles","children":["Retrieve billing cycles",["$","$L73",null,{"id":"retrieve-billing-cycles"}]]}] 4f:["$","p","p-31",{"children":["While the subscription is active, Revolut creates a billing cycle for every billing period - one a month on the 5-seat variation. Each cycle carries its period, ",["$","code","code-0",{"children":"state"}],", and the ",["$","code","code-1",{"children":"order_id"}]," of the order that charged it, so a complete billing history builds up as the subscription runs."]}] 50:["$","p","p-32",{"children":"The subscription's runtime resources look like this:"}] 52:["$","p","p-33",{"children":"The examples below cover two common use cases - a billing-history view and an entitlement check - but they're just a starting point. Explore how the same calls can serve your own business cases: the cycle data can power reconciliation, customer-facing billing pages, dunning workflows, and anything else your product needs."}] 53:["$","h4","h4-4",{"id":"retrieve-cycle-list","children":["Retrieve cycle list",["$","$L73",null,{"id":"retrieve-cycle-list"}]]}] 54:["$","p","p-34",{"children":["The cycle list gives you the subscription's billing history in one call - every cycle so far, its state, and the order that charged each period. Use it for reconciliation and billing-history views, and to discover the current cycle's ",["$","code","code-0",{"children":"id"}]," if you don't have it saved."]}] 55:["$","p","p-35",{"children":["Call ",["$","$L72","a-0",{"use":"$2","to":"/docs/api/merchant#retrieve-subscription-cycle-list","children":"Retrieve a subscription cycle list"}],", passing the ",["$","code","code-0",{"children":"id"}]," of the subscription you created in ",["$","a","a-1",{"href":"#2-subscribe-customer","children":"step 2"}]," as the ",["$","code","code-1",{"children":"subscription_id"}],":"]}] 56:["$","$L75","tabs-7",{"children":["\n",["$","$L76","tabitem-0",{"label":"Request","children":["\n","$L89","\n"]}],"\n",["$","$L76","tabitem-1",{"label":"Response","children":["\n",["$","p","p-0",{"children":["The response lists the subscription's cycles - each carries its ",["$","code","code-0",{"children":"id"}],", period, ",["$","code","code-1",{"children":"state"}],", and the ",["$","code","code-2",{"children":"order_id"}]," that charged it."]}],"\n","$L8a","\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",["$","div","table-0",{"className":"eowryt0","children":["$","table",null,{"className":"eowryt1","children":[["$","thead","thead-0",{"children":["$","tr","tr-0",{"children":[["$","th","th-0",{"children":"Parameter","className":"eowryt6","ref":"$undefined"}],["$","th","th-1",{"children":"Description","className":"eowryt6","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}],"className":"eowryt2","ref":"$undefined"}],["$","tbody","tbody-0",{"children":[["$","tr","tr-0",{"children":[["$","td","td-0",{"children":["$","code","code-0",{"children":"id"}],"className":"eowryt7","ref":"$undefined"}],["$","td","td-1",{"children":"The cycle's identifier - retrieve a single cycle with it","className":"eowryt7","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}],["$","tr","tr-1",{"children":[["$","td","td-0",{"children":["$","code","code-0",{"children":"number"}],"className":"eowryt7","ref":"$undefined"}],["$","td","td-1",{"children":["Cycle sequence number, starting at ",["$","code","code-0",{"children":"1"}]," for the first cycle"],"className":"eowryt7","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}],["$","tr","tr-2",{"children":[["$","td","td-0",{"children":["$","code","code-0",{"children":"state"}],"className":"eowryt7","ref":"$undefined"}],["$","td","td-1",{"children":[["$","code","code-0",{"children":"active"}]," while the cycle runs, ",["$","code","code-1",{"children":"finished"}]," once complete"],"className":"eowryt7","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}],["$","tr","tr-3",{"children":[["$","td","td-0",{"children":[["$","code","code-0",{"children":"start_date"}]," / ",["$","code","code-1",{"children":"end_date"}]],"className":"eowryt7","ref":"$undefined"}],["$","td","td-1",{"children":["The cycle's billing period - ",["$","code","code-0",{"children":"end_date"}]," is when the next cycle starts"],"className":"eowryt7","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}],["$","tr","tr-4",{"children":[["$","td","td-0",{"children":["$","code","code-0",{"children":"order_id"}],"className":"eowryt7","ref":"$undefined"}],["$","td","td-1",{"children":"The order charging this cycle - use it to reconcile the seat charge for the period","className":"eowryt7","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}],["$","tr","tr-5",{"children":[["$","td","td-0",{"children":["$","code","code-0",{"children":"trial"}],"className":"eowryt7","ref":"$undefined"}],["$","td","td-1",{"children":["Whether the cycle is a trial cycle - always ",["$","code","code-0",{"children":"false"}]," for per-seat plans without trials"],"className":"eowryt7","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}]],"className":"eowryt3","ref":"$undefined"}]]}]}],"\n"]}],"\n"]}] 57:["$","h4","h4-5",{"id":"run-entitlement-check","children":["Run entitlement check",["$","$L73",null,{"id":"run-entitlement-check"}]]}] 58:["$","p","p-36",{"children":["A common pattern is gating platform access on the subscription's state: each time the customer logs in, retrieve the current cycle - its ",["$","code","code-0",{"children":"id"}]," is the ",["$","code","code-1",{"children":"current_cycle_id"}]," from the subscription response - and grant access while its ",["$","code","code-2",{"children":"state"}]," is ",["$","code","code-3",{"children":"active"}],"."]}] 59:["$","p","p-37",{"children":["The check runs on every login, so keep it lightweight: retrieve just the current cycle instead of pulling the whole list. Call ",["$","$L72","a-0",{"use":"$2","to":"/docs/api/merchant#retrieve-subscription-cycle","children":"Retrieve a subscription cycle"}],", passing the current cycle's ",["$","code","code-0",{"children":"id"}]," as the ",["$","code","code-1",{"children":"cycle_id"}],":"]}] 5a:["$","$L75","tabs-8",{"children":["\n",["$","$L76","tabitem-0",{"label":"Request","children":["\n","$L8b","\n"]}],"\n",["$","$L76","tabitem-1",{"label":"Response","children":["\n",["$","p","p-0",{"children":["The response is the cycle object itself - the same shape as the list items above. For the entitlement check, ",["$","code","code-0",{"children":"state"}]," is the field that matters: grant access while it's ",["$","code","code-1",{"children":"active"}],"."]}],"\n","$L8c","\n"]}],"\n"]}] 5b:["$","h3","h3-7",{"id":"cancel-subscription","children":["Cancel subscription",["$","$L73",null,{"id":"cancel-subscription"}]]}] 5c:["$","p","p-38",{"children":["When the customer wants to leave, cancel the subscription - Revolut stops billing and cancels any pending orders. You can cancel in any state except ",["$","code","code-0",{"children":"cancelled"}]," or ",["$","code","code-1",{"children":"finished"}],"."]}] 5d:["$","p","p-39",{"children":["Call ",["$","$L72","a-0",{"use":"$2","to":"/docs/api/merchant#cancel-subscription","children":"Cancel a subscription"}],", passing the ",["$","code","code-0",{"children":"id"}]," of the subscription you created in ",["$","a","a-1",{"href":"#2-subscribe-customer","children":"step 2"}]," as the ",["$","code","code-1",{"children":"subscription_id"}],":"]}] 5e:["$","$L75","tabs-9",{"children":["\n",["$","$L76","tabitem-0",{"label":"Request","children":["\n","$L8d","\n"]}],"\n",["$","$L76","tabitem-1",{"label":"Response","children":["\n",["$","p","p-0",{"children":["The subscription is marked ",["$","code","code-0",{"children":"cancelled"}]," - no further cycles are created."]}],"\n","$L8e","\n"]}],"\n"]}] 5f:["$","p","p-40",{"children":["The subscription moves to ",["$","code","code-0",{"children":"cancelled"}]," - a final state: it can't be reactivated, so if the customer returns, create a new subscription for them. A ",["$","code","code-1",{"children":"SUBSCRIPTION_CANCELLED"}]," webhook event is sent whether the cancellation came from you or the customer - see ",["$","$L72","a-0",{"use":"$2","to":"/docs/guides/merchant/billing-subscriptions/subscription-plans#subscription-states","children":"Subscription states"}]," and ",["$","$L72","a-1",{"use":"$2","to":"/docs/guides/merchant/billing-subscriptions/api/webhooks","children":"Track subscriptions with webhooks"}],"."]}] 60:["$","p","p-41",{"children":["If you ",["$","a","a-0",{"href":"#run-entitlement-check","children":"run the entitlement check"}],", this is where it stops granting access: end access immediately, or - if you let customers finish what they paid for - stop at the current cycle's ",["$","code","code-0",{"children":"end_date"}],". Cancelling stops future charges only - it doesn't refund completed cycles."]}] 61:["$","hr","hr-2",{}] 62:["$","h2","h2-3",{"id":"implementation-checklist","children":["Implementation checklist",["$","$L73",null,{"id":"implementation-checklist"}]]}] 63:["$","p","p-42",{"children":["Confirm your per-seat integration works end to end. Run the checks in the Sandbox environment first - set the base URL of your API calls to ",["$","code","code-0",{"children":"sandbox-merchant.revolut.com"}]," - then repeat them in production before going live:"]}] 64:["$","ul","ul-2",{"className":"contains-task-list","children":["\n",["$","li","li-0",{"className":"task-list-item","children":[["$","$L74","input-0",{"wrapper":{"use":"span"},"type":"checkbox"}]," Created a plan with the seat price as an item - ",["$","code","code-0",{"children":"flat"}]," with ",["$","code","code-1",{"children":"quantity"}]," on the static paths, ",["$","code","code-2",{"children":"usage"}]," with ",["$","code","code-3",{"children":"latest"}]," aggregation on the dynamic path - and saved the variation ",["$","code","code-4",{"children":"id"}]," the customer subscribes to"]}],"\n",["$","li","li-1",{"className":"task-list-item","children":[["$","$L74","input-0",{"wrapper":{"use":"span"},"type":"checkbox"}]," Subscribed a customer, collected the first payment, and confirmed the subscription is ",["$","code","code-0",{"children":"active"}]]}],"\n",["$","li","li-2",{"className":"task-list-item","children":[["$","$L74","input-0",{"wrapper":{"use":"span"},"type":"checkbox"}]," Static paths - confirmed each cycle bills ",["$","code","code-0",{"children":"amount"}]," x ",["$","code","code-1",{"children":"quantity"}],", and a scheduled variation switch moves the customer to the new seat pack at cycle end"]}],"\n",["$","li","li-3",{"className":"task-list-item","children":[["$","$L74","input-0",{"wrapper":{"use":"span"},"type":"checkbox"}]," Dynamic path - reports always send an ",["$","code","code-0",{"children":"Idempotency-Key"}]," and target the right ",["$","code","code-1",{"children":"subscription_item_code"}]]}],"\n",["$","li","li-4",{"className":"task-list-item","children":[["$","$L74","input-0",{"wrapper":{"use":"span"},"type":"checkbox"}]," Dynamic path - confirmed an unreported cycle charges ",["$","code","code-0",{"children":"0"}],", and corrections land before the cycle's ",["$","code","code-1",{"children":"usage_cutoff_date"}]]}],"\n",["$","li","li-5",{"className":"task-list-item","children":[["$","$L74","input-0",{"wrapper":{"use":"span"},"type":"checkbox"}]," Cancelled a test subscription - ",["$","code","code-0",{"children":"204"}]," response, no new cycles created, ",["$","code","code-1",{"children":"SUBSCRIPTION_CANCELLED"}]," event received"]}],"\n"]}] 65:["$","p","p-43",{"children":"For verifying the payment solution itself - widget behaviour, test cards, webhook receipt for the order - use the implementation checklist in the payment method guide you followed."}] 66:["$","hr","hr-3",{}] 67:["$","h2","h2-4",{"id":"whats-next","children":["What's next",["$","$L73",null,{"id":"whats-next"}]]}] 68:["$","div","linkcardgrid-1",{"className":"quhugq0","children":["\n",["$","div","linkcard-0",{"className":"quhugq1","children":[["$","$L82",null,{"useIcon":"Repayment"}],["$","div",null,{"data-has-icon":true,"className":"quhugq4","children":[["$","a",null,{"className":"quhugq5","href":"/docs/guides/merchant/billing-subscriptions/api/fixed","children":"Build a fixed-rate subscription"}],["$","div",null,{"className":"quhugq6","children":"Charge a fixed recurring amount - the simplest subscription flow"}]]}]]}],"\n",["$","div","linkcard-1",{"className":"quhugq1","children":[["$","$L82",null,{"useIcon":"LimitHigh"}],["$","div",null,{"data-has-icon":true,"className":"quhugq4","children":[["$","a",null,{"className":"quhugq5","href":"/docs/guides/merchant/billing-subscriptions/api/usage-based","children":"Build a usage-based subscription"}],["$","div",null,{"className":"quhugq6","children":"Meter usage, report it via the API, and settle charges at cycle end"}]]}]]}],"\n",["$","div","linkcard-2",{"className":"quhugq1","children":[["$","$L82",null,{"useIcon":"Voucher"}],["$","div",null,{"data-has-icon":true,"className":"quhugq4","children":[["$","a",null,{"className":"quhugq5","href":"/docs/guides/merchant/billing-subscriptions/api/trials","children":"Build a subscription with trials and introductory pricing"}],["$","div",null,{"className":"quhugq6","children":"Offer free trials and promotional pricing phases"}]]}]]}],"\n",["$","div","linkcard-3",{"className":"quhugq1","children":[["$","$L82",null,{"useIcon":"Webhook"}],["$","div",null,{"data-has-icon":true,"className":"quhugq4","children":[["$","a",null,{"className":"quhugq5","href":"/docs/guides/merchant/billing-subscriptions/api/webhooks","children":"Track subscriptions with webhooks"}],["$","div",null,{"className":"quhugq6","children":"Receive real-time events when subscription states change"}]]}]]}],"\n"]}] 69:["$","div",null,{"className":"_10qzu534","children":["$","$L8f",null,{"toc":[{"title":"How it works","titleParts":"$undefined","url":"#how-it-works","depth":2},{"title":"Before you begin","titleParts":"$undefined","url":"#before-you-begin","depth":3},{"title":"Implement per-seat subscription","titleParts":"$undefined","url":"#implement-per-seat-subscription","depth":2},{"title":"1. Create plan for per-seat pricing","titleParts":"$undefined","url":"#1-create-plan-for-per-seat-pricing","depth":3},{"title":"2. Subscribe customer","titleParts":"$undefined","url":"#2-subscribe-customer","depth":3},{"title":"3. Collect first payment","titleParts":"$undefined","url":"#3-collect-first-payment","depth":3},{"title":"3.1 Retrieve setup order","titleParts":"$undefined","url":"#3-1-retrieve-setup-order","depth":4},{"title":"3.2 Build your payment acceptance solution","titleParts":"$undefined","url":"#3-2-build-your-payment-acceptance-solution","depth":4},{"title":"4. Verify subscription state","titleParts":"$undefined","url":"#4-verify-subscription-state","depth":3},{"title":"Operate per-seat subscription","titleParts":"$undefined","url":"#operate-per-seat-subscription","depth":2},{"title":"Adjust seat count","titleParts":"$undefined","url":"#adjust-seat-count","depth":3},{"title":"Report seat count","titleParts":"$undefined","url":"#report-seat-count","depth":4},{"title":"Change seat count","titleParts":"$undefined","url":"#change-seat-count","depth":4},{"title":"Retrieve billing cycles","titleParts":"$undefined","url":"#retrieve-billing-cycles","depth":3},{"title":"Retrieve cycle list","titleParts":"$undefined","url":"#retrieve-cycle-list","depth":4},{"title":"Run entitlement check","titleParts":"$undefined","url":"#run-entitlement-check","depth":4},{"title":"Cancel subscription","titleParts":"$undefined","url":"#cancel-subscription","depth":3},{"title":"Implementation checklist","titleParts":"$undefined","url":"#implementation-checklist","depth":2},{"title":"What's next","titleParts":"$undefined","url":"#whats-next","depth":2}]}]}] 6a:["$","$L90",null,{}] 6b:["$","$L91","Build a per-seat subscription model",{}] 6c:["$","div",null,{"className":"gdnlim0","role":"navigation","data-event-key":"bottom_nav","children":[["$","$L92",null,{"data-shortcut":"[","data-rtl":"$undefined","useIcon":"NavigationBack","use":"$2","to":"/docs/guides/merchant/billing-subscriptions/api/fixed","className":"gdnlim1","children":["$","$L93",null,{"className":"gdnlim2","children":[["$","$L94",null,{"data-rtl":"$undefined","className":"gdnlim3","children":"Fixed-rate subscription"}],["$","$L95",null,{"children":"Previous"}]]}]}],["$","$L92",null,{"data-shortcut":"]","data-rtl":true,"useIcon":"NavigationForward","use":"$2","to":"/docs/guides/merchant/billing-subscriptions/api/usage-based","className":"gdnlim1","children":["$","$L93",null,{"className":"gdnlim2","children":[["$","$L94",null,{"data-rtl":true,"className":"gdnlim3","children":"Usage-based subscription"}],["$","$L95",null,{"children":"Next"}]]}]}]]}] 6d:["$","$L96",null,{"children":[["$","$L97",null,{"toc":"$69:props:children:props:toc"}],false]}] 6e:["$","div",null,{"className":"wp3eky0","children":["$","$L98",null,{}]}] 6f:["$","p","1",{"className":"_19k157u7","children":"We are also registered with the Financial Conduct Authority to offer cryptocurrency services under the Money Laundering, Terrorist Financing and Transfer of Funds (Information on the Payer) Regulations 2017."}] 70:["$","p","2",{"className":"_19k157u7","children":"Revolut's commodities service is not regulated by the FCA."}] 78:["$","td","td-1",{"children":["Units grouped into one billable package - optional, defaults to ",["$","code","code-0",{"children":"1"}],"; for seats, leave it at ",["$","code","code-1",{"children":"1"}]],"className":"eowryt7","ref":"$undefined"}] 79:["$","tr","tr-12",{"children":[["$","td","td-0",{"children":["$","code","code-0",{"children":"subscription_items[].code"}],"className":"eowryt7","ref":"$undefined"}],["$","td","td-1",{"children":["Merchant-defined identifier for a ",["$","code","code-0",{"children":"usage"}]," item - unique within the phase; you supply it when reporting the seat count"],"className":"eowryt7","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}] 7a:["$","tr","tr-13",{"children":[["$","td","td-0",{"children":["$","code","code-0",{"children":"subscription_items[].usage_aggregation_method"}],"className":"eowryt7","ref":"$undefined"}],["$","td","td-1",{"children":["How reported counts become the charge - ",["$","code","code-0",{"children":"latest"}]," uses the most recently reported value at cycle end"],"className":"eowryt7","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}] 7b:["$","tr","tr-14",{"children":[["$","td","td-0",{"children":["$","code","code-0",{"children":"subscription_items[].amount"}],"className":"eowryt7","ref":"$undefined"}],["$","td","td-1",{"children":["Price per seat in minor units - ",["$","code","code-0",{"children":"1500"}]," is £15.00"],"className":"eowryt7","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}] 7c:["$","$L76","tabitem-1",{"label":"Response","children":["\n",["$","p","p-0",{"children":["The response returns the plan with a system-generated ",["$","code","code-0",{"children":"id"}],", an ",["$","code","code-1",{"children":"id"}]," for each variation and phase, and an ",["$","code","code-2",{"children":"id"}]," for each item."]}],"\n",["$","p","p-1",{"children":["Save the ",["$","code","code-0",{"children":"id"}]," of the variation the customer subscribes to - here, the 5-seat variation for the walkthrough. The 10-seat variation comes back in ",["$","a","a-0",{"href":"#change-seat-count","children":"Change seat count"}],", and on the dynamic path, customers subscribe to the flexible variation instead."]}],"\n","$L99","\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",["$","div","table-0",{"className":"eowryt0","children":["$","table",null,{"className":"eowryt1","children":[["$","thead","thead-0",{"children":["$","tr","tr-0",{"children":[["$","th","th-0",{"children":"Parameter","className":"eowryt6","ref":"$undefined"}],["$","th","th-1",{"children":"Description","className":"eowryt6","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}],"className":"eowryt2","ref":"$undefined"}],["$","tbody","tbody-0",{"children":[["$","tr","tr-0",{"children":[["$","td","td-0",{"children":["$","code","code-0",{"children":"id"}],"className":"eowryt7","ref":"$undefined"}],["$","td","td-1",{"children":"The plan ID - the plan's identifier in the API","className":"eowryt7","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}],["$","tr","tr-1",{"children":[["$","td","td-0",{"children":["$","code","code-0",{"children":"state"}],"className":"eowryt7","ref":"$undefined"}],["$","td","td-1",{"children":[["$","code","code-0",{"children":"active"}]," - the plan is ready to accept subscriptions"],"className":"eowryt7","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}],["$","tr","tr-2",{"children":[["$","td","td-0",{"children":["$","code","code-0",{"children":"variations[].id"}],"className":"eowryt7","ref":"$undefined"}],["$","td","td-1",{"children":["The variation IDs - save the one the customer subscribes to; you'll use it in ",["$","a","a-0",{"href":"#2-subscribe-customer","children":"step 2"}]],"className":"eowryt7","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}],["$","tr","tr-3",{"children":[["$","td","td-0",{"children":["$","code","code-0",{"children":"phases[].id"}],"className":"eowryt7","ref":"$undefined"}],["$","td","td-1",{"children":"The phase IDs - each billing cycle is created under one of them","className":"eowryt7","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}],["$","tr","tr-4",{"children":[["$","td","td-0",{"children":["$","code","code-0",{"children":"subscription_items[].id"}],"className":"eowryt7","ref":"$undefined"}],["$","td","td-1",{"children":"The item IDs - generated for each item you configured","className":"eowryt7","ref":"$undefined"}]],"className":"eowryt5","ref":"$undefined"}]],"className":"eowryt3","ref":"$undefined"}]]}]}],"\n"]}] 7f:["$","a","a-0",{"href":"#retrieve-billing-cycles","children":"Retrieve billing cycles"}] 9a:T1529, Team plan 5-seat variation - £75.00/month 10-seat variation - £150.00/month Flexible seats - £15.00 per reported seat flat item - quantity 5 x £15.00 flat item - quantity 10 x £15.00 usage item - latest reported count x £15.00 18:["$","div","Mermaid-0",{"className":"wzy01m0 _8qd6110","children":[[["$","div",null,{"dangerouslySetInnerHTML":{"__html":"$9a"}}],"$L9b"],"$L9c"]}] 9d:T10e9, Subscription c33e76eb - state: active Cycle 004c9dd4 - current, state: active Cycle 055f3a58 - state: finished Order 30b9d75b - charges £75.00 Order 22425f3b - charged £75.00 51:["$","div","Mermaid-1",{"className":"wzy01m0 _8qd6110","children":[[["$","div",null,{"dangerouslySetInnerHTML":{"__html":"$9d"}}],"$L9e"],"$L9f"]}] a1:T153d, Team plan 5-seat variation - £75.00/month 10-seat variation - £150.00/month Flexible seats - £15.00 per reported seat flat item - quantity 5 x £15.00 flat item - quantity 10 x £15.00 usage item - latest reported count x £15.00 9b:["$","$La0",null,{"ariaLabel":"Preview diagram","initialScale":1,"children":["$","div",null,{"className":"_8qd6111","dangerouslySetInnerHTML":{"__html":"$a1"}}]}] 9c:["$","div",null,{"className":"wzy01m1","children":["$","$La2",null,{"code":"flowchart TD\n subgraph plan [\"Team plan\"]\n subgraph seats5 [\"5-seat variation - £75.00/month\"]\n item1[\"flat item - quantity 5 x £15.00\"]\n end\n subgraph seats10 [\"10-seat variation - £150.00/month\"]\n item2[\"flat item - quantity 10 x £15.00\"]\n end\n subgraph flex [\"Flexible seats - £15.00 per reported seat\"]\n item3[\"usage item - latest reported count x £15.00\"]\n end\n end"}]}] a3:T10fd, Subscription c33e76eb - state: active Cycle 004c9dd4 - current, state: active Cycle 055f3a58 - state: finished Order 30b9d75b - charges £75.00 Order 22425f3b - charged £75.00 9e:["$","$La0",null,{"ariaLabel":"Preview diagram","initialScale":1,"children":["$","div",null,{"className":"_8qd6111","dangerouslySetInnerHTML":{"__html":"$a3"}}]}] 9f:["$","div",null,{"className":"wzy01m1","children":["$","$La2",null,{"code":"flowchart TD\n subgraph subscription [\"Subscription c33e76eb - state: active\"]\n subgraph cycle2 [\"Cycle 004c9dd4 - current, state: active\"]\n order2[\"Order 30b9d75b - charges £75.00\"]\n end\n subgraph cycle1 [\"Cycle 055f3a58 - state: finished\"]\n order1[\"Order 22425f3b - charged £75.00\"]\n end\n end"}]}] a5:T3413,
POST /api/subscription-plans HTTP/1.1
Host: merchant.revolut.com
Authorization: Bearer sk_abcdef12347890_...
Revolut-Api-Version: 2026-08-17
Content-Type: application/json

{
  "name": "Team plan",
  "variations": [
    {
      "phases": [
        {
          "ordinal": 1,
          "cycle_duration": "P1M",
          "amount": 7500,
          "currency": "GBP",
          "subscription_items": [
            {
              "type": "flat",
              "name": "Team seats",
              "unit": "seat",
              "quantity": 5,
              "amount": 1500,
              "currency": "GBP"
            }
          ]
        }
      ]
    },
    {
      "phases": [
        {
          "ordinal": 1,
          "cycle_duration": "P1M",
          "amount": 15000,
          "currency": "GBP",
          "subscription_items": [
            {
              "type": "flat",
              "name": "Team seats",
              "unit": "seat",
              "quantity": 10,
              "amount": 1500,
              "currency": "GBP"
            }
          ]
        }
      ]
    },
    {
      "phases": [
        {
          "ordinal": 1,
          "cycle_duration": "P1M",
          "subscription_items": [
            {
              "type": "usage",
              "name": "Active seats",
              "unit": "seat",
              "code": "active_seats",
              "usage_aggregation_method": "latest",
              "amount": 1500,
              "currency": "GBP"
            }
          ]
        }
      ]
    }
  ]
}
77:["$","div","CodeBlock-0",{"className":"wzy01m0 _18b50nc0","children":[[["$","div",null,{"className":"_18b50nc1","children":["$","span",null,{"className":"_18b50nc2","children":[false,"Request example"]}]}],["$","$La4",null,{"className":"_18b50nc3","defaultWrap":false,"children":["$","div",null,{"className":"_18b50nc4 _18b50nc5","dangerouslySetInnerHTML":{"__html":"$a5"}}]}]],"$La6"]}] a7:Tbf2,
POST /api/subscriptions HTTP/1.1
Host: merchant.revolut.com
Authorization: Bearer sk_abcdef12347890_...
Revolut-Api-Version: 2026-08-17
Content-Type: application/json
Idempotency-Key: 916b2ee5-a6bf-441d-9077-e4b9fc93c5ba

{
  "plan_variation_id": "993236c2-fd84-4b1f-b90a-f9691537beb8",
  "customer_id": "650e8400-e29b-41d4-a716-446655440001",
  "external_reference": "team_3f9a2c",
  "setup_order_redirect_url": "https://example.com/subscription/complete"
}
7d:["$","div","CodeBlock-0",{"className":"wzy01m0 _18b50nc0","children":[[["$","div",null,{"className":"_18b50nc1","children":["$","span",null,{"className":"_18b50nc2","children":[false,"Request example"]}]}],["$","$La4",null,{"className":"_18b50nc3","defaultWrap":false,"children":["$","div",null,{"className":"_18b50nc4 _18b50nc5","dangerouslySetInnerHTML":{"__html":"$a7"}}]}]],"$La8"]}] a9:Te0e,
{
  "id": "c33e76eb-bc87-4f4d-a56b-88c2a069268d",
  "external_reference": "team_3f9a2c",
  "state": "pending",
  "customer_id": "650e8400-e29b-41d4-a716-446655440001",
  "plan_id": "4fe4870c-f968-42dc-b2fb-6ac4ac9cbb87",
  "plan_variation_id": "993236c2-fd84-4b1f-b90a-f9691537beb8",
  "payment_method_type": "automatic",
  "created_at": "2026-01-26T09:15:00.036001Z",
  "updated_at": "2026-01-26T09:15:00.036001Z",
  "setup_order_id": "22425f3b-ac69-4c97-add5-905c4dc831fd",
  "current_cycle_id": "055f3a58-89d8-4a45-ac95-cbf27e053f2d"
}
7e:["$","div","CodeBlock-0",{"className":"wzy01m0 _18b50nc0","children":[[["$","div",null,{"className":"_18b50nc1","children":["$","span",null,{"className":"_18b50nc2","children":[false,"Response example"]}]}],["$","$La4",null,{"className":"_18b50nc3","defaultWrap":false,"children":["$","div",null,{"className":"_18b50nc4 _18b50nc5","dangerouslySetInnerHTML":{"__html":"$a9"}}]}]],"$Laa"]}] ab:T4b4,
GET /api/orders/{order_id} HTTP/1.1
Host: merchant.revolut.com
Authorization: Bearer sk_abcdef12347890_...
Revolut-Api-Version: 2026-08-17
80:["$","div","CodeBlock-0",{"className":"wzy01m0 _18b50nc0","children":[[["$","div",null,{"className":"_18b50nc1","children":["$","span",null,{"className":"_18b50nc2","children":[false,"Request example"]}]}],["$","$La4",null,{"className":"_18b50nc3","defaultWrap":false,"children":["$","div",null,{"className":"_18b50nc4 _18b50nc5","dangerouslySetInnerHTML":{"__html":"$ab"}}]}]],["$","div",null,{"className":"wzy01m1","children":["$","$La2",null,{"code":"GET /api/orders/{order_id} HTTP/1.1\nHost: merchant.revolut.com\nAuthorization: Bearer sk_abcdef12347890_...\nRevolut-Api-Version: 2026-08-17\n"}]}]]}] ac:Ta6a,
{
  "id": "22425f3b-ac69-4c97-add5-905c4dc831fd",
  "token": "7fef7ce2-2627-4c35-9b07-ac6f46cbff01",
  "state": "pending",
  "created_at": "2026-01-26T09:15:00.036001Z",
  "updated_at": "2026-01-26T09:15:00.036001Z",
  "amount": 7500,
  "currency": "GBP",
  "checkout_url": "https://checkout.revolut.com/payment-link/7fef7ce2-2627-4c35-9b07-ac6f46cbff01"
}
81:["$","div","CodeBlock-0",{"className":"wzy01m0 _18b50nc0","children":[[["$","div",null,{"className":"_18b50nc1","children":["$","span",null,{"className":"_18b50nc2","children":[false,"Response example"]}]}],["$","$La4",null,{"className":"_18b50nc3","defaultWrap":false,"children":["$","div",null,{"className":"_18b50nc4 _18b50nc5","dangerouslySetInnerHTML":{"__html":"$ac"}}]}]],["$","div",null,{"className":"wzy01m1","children":["$","$La2",null,{"code":"{\n \"id\": \"22425f3b-ac69-4c97-add5-905c4dc831fd\",\n \"token\": \"7fef7ce2-2627-4c35-9b07-ac6f46cbff01\",\n \"state\": \"pending\",\n \"created_at\": \"2026-01-26T09:15:00.036001Z\",\n \"updated_at\": \"2026-01-26T09:15:00.036001Z\",\n \"amount\": 7500,\n \"currency\": \"GBP\",\n \"checkout_url\": \"https://checkout.revolut.com/payment-link/7fef7ce2-2627-4c35-9b07-ac6f46cbff01\"\n}\n"}]}]]}] ad:T4c2,
GET /api/subscriptions/{subscription_id} HTTP/1.1
Host: merchant.revolut.com
Authorization: Bearer sk_abcdef12347890_...
Revolut-Api-Version: 2026-08-17
83:["$","div","CodeBlock-0",{"className":"wzy01m0 _18b50nc0","children":[[["$","div",null,{"className":"_18b50nc1","children":["$","span",null,{"className":"_18b50nc2","children":[false,"Request example"]}]}],["$","$La4",null,{"className":"_18b50nc3","defaultWrap":false,"children":["$","div",null,{"className":"_18b50nc4 _18b50nc5","dangerouslySetInnerHTML":{"__html":"$ad"}}]}]],["$","div",null,{"className":"wzy01m1","children":["$","$La2",null,{"code":"GET /api/subscriptions/{subscription_id} HTTP/1.1\nHost: merchant.revolut.com\nAuthorization: Bearer sk_abcdef12347890_...\nRevolut-Api-Version: 2026-08-17\n"}]}]]}] ae:Tf51,
{
  "id": "c33e76eb-bc87-4f4d-a56b-88c2a069268d",
  "external_reference": "team_3f9a2c",
  "state": "active",
  "customer_id": "650e8400-e29b-41d4-a716-446655440001",
  "plan_id": "4fe4870c-f968-42dc-b2fb-6ac4ac9cbb87",
  "plan_variation_id": "993236c2-fd84-4b1f-b90a-f9691537beb8",
  "payment_method_type": "automatic",
  "payment_method_id": "92e6646e-8202-4ab6-816e-7fbbce66f4a7",
  "created_at": "2026-01-26T09:15:00.036001Z",
  "updated_at": "2026-01-26T09:20:00.036001Z",
  "start_date": "2026-01-26T09:20:00.036001Z",
  "current_cycle_id": "055f3a58-89d8-4a45-ac95-cbf27e053f2d"
}
84:["$","div","CodeBlock-0",{"className":"wzy01m0 _18b50nc0","children":[[["$","div",null,{"className":"_18b50nc1","children":["$","span",null,{"className":"_18b50nc2","children":[false,"Response example"]}]}],["$","$La4",null,{"className":"_18b50nc3","defaultWrap":false,"children":["$","div",null,{"className":"_18b50nc4 _18b50nc5","dangerouslySetInnerHTML":{"__html":"$ae"}}]}]],"$Laf"]}] b0:Tbbd,
POST /api/subscription-usages HTTP/1.1
Host: merchant.revolut.com
Authorization: Bearer sk_abcdef12347890_...
Revolut-Api-Version: 2026-08-17
Content-Type: application/json
Idempotency-Key: a5e687aa-251e-47e5-b2b0-cd6a773b7097

{
  "subscription_id": "beebf6fb-f887-4bcf-af78-d46c7be5825f",
  "subscription_item_code": "active_seats",
  "usage_date": "2026-02-15T09:30:00Z",
  "quantity": 12
}
85:["$","div","CodeBlock-0",{"className":"wzy01m0 _18b50nc0","children":[[["$","div",null,{"className":"_18b50nc1","children":["$","span",null,{"className":"_18b50nc2","children":[false,"Request example"]}]}],["$","$La4",null,{"className":"_18b50nc3","defaultWrap":false,"children":["$","div",null,{"className":"_18b50nc4 _18b50nc5","dangerouslySetInnerHTML":{"__html":"$b0"}}]}]],"$Lb1"]}] b2:Ta62,
{
  "id": "e965f21e-7d98-4e3b-847f-ae1a562c5468",
  "subscription_id": "beebf6fb-f887-4bcf-af78-d46c7be5825f",
  "subscription_cycle_id": "12e698d4-5110-4c65-8446-d4d879309144",
  "subscription_item_code": "active_seats",
  "usage_date": "2026-02-15T09:30:00Z",
  "quantity": 12,
  "created_at": "2026-02-15T09:30:05Z",
  "updated_at": "2026-02-15T09:30:05Z"
}
86:["$","div","CodeBlock-0",{"className":"wzy01m0 _18b50nc0","children":[[["$","div",null,{"className":"_18b50nc1","children":["$","span",null,{"className":"_18b50nc2","children":[false,"Response example"]}]}],["$","$La4",null,{"className":"_18b50nc3","defaultWrap":false,"children":["$","div",null,{"className":"_18b50nc4 _18b50nc5","dangerouslySetInnerHTML":{"__html":"$b2"}}]}]],["$","div",null,{"className":"wzy01m1","children":["$","$La2",null,{"code":"{\n \"id\": \"e965f21e-7d98-4e3b-847f-ae1a562c5468\",\n \"subscription_id\": \"beebf6fb-f887-4bcf-af78-d46c7be5825f\",\n \"subscription_cycle_id\": \"12e698d4-5110-4c65-8446-d4d879309144\",\n \"subscription_item_code\": \"active_seats\",\n \"usage_date\": \"2026-02-15T09:30:00Z\",\n \"quantity\": 12,\n \"created_at\": \"2026-02-15T09:30:05Z\",\n \"updated_at\": \"2026-02-15T09:30:05Z\"\n}\n"}]}]]}] b3:T898,
POST /api/subscriptions/{subscription_id}/change-plan HTTP/1.1
Host: merchant.revolut.com
Authorization: Bearer sk_abcdef12347890_...
Revolut-Api-Version: 2026-08-17
Content-Type: application/json

{
  "plan_variation_id": "72222cd7-87d5-408b-b604-880a6ac59451",
  "scheduled": "at_cycle_end"
}
87:["$","div","CodeBlock-0",{"className":"wzy01m0 _18b50nc0","children":[[["$","div",null,{"className":"_18b50nc1","children":["$","span",null,{"className":"_18b50nc2","children":[false,"Request example"]}]}],["$","$La4",null,{"className":"_18b50nc3","defaultWrap":false,"children":["$","div",null,{"className":"_18b50nc4 _18b50nc5","dangerouslySetInnerHTML":{"__html":"$b3"}}]}]],["$","div",null,{"className":"wzy01m1","children":["$","$La2",null,{"code":"POST /api/subscriptions/{subscription_id}/change-plan HTTP/1.1\nHost: merchant.revolut.com\nAuthorization: Bearer sk_abcdef12347890_...\nRevolut-Api-Version: 2026-08-17\nContent-Type: application/json\n\n{\n \"plan_variation_id\": \"72222cd7-87d5-408b-b604-880a6ac59451\",\n \"scheduled\": \"at_cycle_end\"\n}\n"}]}]]}] 88:["$","div","CodeBlock-0",{"className":"wzy01m0 _18b50nc0","children":[[["$","div",null,{"className":"_18b50nc1","children":["$","span",null,{"className":"_18b50nc2","children":[false,"Response example"]}]}],["$","$La4",null,{"className":"_18b50nc3","defaultWrap":false,"children":["$","div",null,{"className":"_18b50nc4 _18b50nc5","dangerouslySetInnerHTML":{"__html":"
HTTP/1.1 204 No Content
"}}]}]],["$","div",null,{"className":"wzy01m1","children":["$","$La2",null,{"code":"HTTP/1.1 204 No Content\n"}]}]]}] b4:T4c9,
GET /api/subscriptions/{subscription_id}/cycles HTTP/1.1
Host: merchant.revolut.com
Authorization: Bearer sk_abcdef12347890_...
Revolut-Api-Version: 2026-08-17
89:["$","div","CodeBlock-0",{"className":"wzy01m0 _18b50nc0","children":[[["$","div",null,{"className":"_18b50nc1","children":["$","span",null,{"className":"_18b50nc2","children":[false,"Request example"]}]}],["$","$La4",null,{"className":"_18b50nc3","defaultWrap":false,"children":["$","div",null,{"className":"_18b50nc4 _18b50nc5","dangerouslySetInnerHTML":{"__html":"$b4"}}]}]],["$","div",null,{"className":"wzy01m1","children":["$","$La2",null,{"code":"GET /api/subscriptions/{subscription_id}/cycles HTTP/1.1\nHost: merchant.revolut.com\nAuthorization: Bearer sk_abcdef12347890_...\nRevolut-Api-Version: 2026-08-17\n"}]}]]}] b5:T1bcb,
{
  "cycles": [
    {
      "id": "004c9dd4-434c-44be-af4e-8d3c8f9864a6",
      "subscription_id": "c33e76eb-bc87-4f4d-a56b-88c2a069268d",
      "plan_variation_id": "993236c2-fd84-4b1f-b90a-f9691537beb8",
      "plan_variation_phase_id": "3de61e3f-c665-4627-b865-dc0980578cbc",
      "number": 2,
      "previous_cycle_id": "055f3a58-89d8-4a45-ac95-cbf27e053f2d",
      "state": "active",
      "start_date": "2026-02-26T09:20:00.036001Z",
      "end_date": "2026-03-26T09:20:00.036001Z",
      "order_id": "30b9d75b-08f1-4de8-a431-25627f691493",
      "trial": false
    },
    {
      "id": "055f3a58-89d8-4a45-ac95-cbf27e053f2d",
      "subscription_id": "c33e76eb-bc87-4f4d-a56b-88c2a069268d",
      "plan_variation_id": "993236c2-fd84-4b1f-b90a-f9691537beb8",
      "plan_variation_phase_id": "3de61e3f-c665-4627-b865-dc0980578cbc",
      "number": 1,
      "state": "finished",
      "start_date": "2026-01-26T09:20:00.036001Z",
      "end_date": "2026-02-26T09:20:00.036001Z",
      "order_id": "22425f3b-ac69-4c97-add5-905c4dc831fd",
      "trial": false
    }
  ]
}
8a:["$","div","CodeBlock-0",{"className":"wzy01m0 _18b50nc0","children":[[["$","div",null,{"className":"_18b50nc1","children":["$","span",null,{"className":"_18b50nc2","children":[false,"Response example"]}]}],["$","$La4",null,{"className":"_18b50nc3","defaultWrap":false,"children":["$","div",null,{"className":"_18b50nc4 _18b50nc5","dangerouslySetInnerHTML":{"__html":"$b5"}}]}]],"$Lb6"]}] b7:T4d4,
GET /api/subscriptions/{subscription_id}/cycles/{cycle_id} HTTP/1.1
Host: merchant.revolut.com
Authorization: Bearer sk_abcdef12347890_...
Revolut-Api-Version: 2026-08-17
8b:["$","div","CodeBlock-0",{"className":"wzy01m0 _18b50nc0","children":[[["$","div",null,{"className":"_18b50nc1","children":["$","span",null,{"className":"_18b50nc2","children":[false,"Request example"]}]}],["$","$La4",null,{"className":"_18b50nc3","defaultWrap":false,"children":["$","div",null,{"className":"_18b50nc4 _18b50nc5","dangerouslySetInnerHTML":{"__html":"$b7"}}]}]],["$","div",null,{"className":"wzy01m1","children":["$","$La2",null,{"code":"GET /api/subscriptions/{subscription_id}/cycles/{cycle_id} HTTP/1.1\nHost: merchant.revolut.com\nAuthorization: Bearer sk_abcdef12347890_...\nRevolut-Api-Version: 2026-08-17\n"}]}]]}] b8:Tde2,
{
  "id": "004c9dd4-434c-44be-af4e-8d3c8f9864a6",
  "subscription_id": "c33e76eb-bc87-4f4d-a56b-88c2a069268d",
  "plan_variation_id": "993236c2-fd84-4b1f-b90a-f9691537beb8",
  "plan_variation_phase_id": "3de61e3f-c665-4627-b865-dc0980578cbc",
  "number": 2,
  "previous_cycle_id": "055f3a58-89d8-4a45-ac95-cbf27e053f2d",
  "state": "active",
  "start_date": "2026-02-26T09:20:00.036001Z",
  "end_date": "2026-03-26T09:20:00.036001Z",
  "order_id": "30b9d75b-08f1-4de8-a431-25627f691493",
  "trial": false
}
8c:["$","div","CodeBlock-0",{"className":"wzy01m0 _18b50nc0","children":[[["$","div",null,{"className":"_18b50nc1","children":["$","span",null,{"className":"_18b50nc2","children":[false,"Response example"]}]}],["$","$La4",null,{"className":"_18b50nc3","defaultWrap":false,"children":["$","div",null,{"className":"_18b50nc4 _18b50nc5","dangerouslySetInnerHTML":{"__html":"$b8"}}]}]],"$Lb9"]}] ba:T4ca,
POST /api/subscriptions/{subscription_id}/cancel HTTP/1.1
Host: merchant.revolut.com
Authorization: Bearer sk_abcdef12347890_...
Revolut-Api-Version: 2026-08-17
8d:["$","div","CodeBlock-0",{"className":"wzy01m0 _18b50nc0","children":[[["$","div",null,{"className":"_18b50nc1","children":["$","span",null,{"className":"_18b50nc2","children":[false,"Request example"]}]}],["$","$La4",null,{"className":"_18b50nc3","defaultWrap":false,"children":["$","div",null,{"className":"_18b50nc4 _18b50nc5","dangerouslySetInnerHTML":{"__html":"$ba"}}]}]],["$","div",null,{"className":"wzy01m1","children":["$","$La2",null,{"code":"POST /api/subscriptions/{subscription_id}/cancel HTTP/1.1\nHost: merchant.revolut.com\nAuthorization: Bearer sk_abcdef12347890_...\nRevolut-Api-Version: 2026-08-17\n"}]}]]}] 8e:["$","div","CodeBlock-0",{"className":"wzy01m0 _18b50nc0","children":[[["$","div",null,{"className":"_18b50nc1","children":["$","span",null,{"className":"_18b50nc2","children":[false,"Response example"]}]}],["$","$La4",null,{"className":"_18b50nc3","defaultWrap":false,"children":["$","div",null,{"className":"_18b50nc4 _18b50nc5","dangerouslySetInnerHTML":{"__html":"
HTTP/1.1 204 No Content
"}}]}]],["$","div",null,{"className":"wzy01m1","children":["$","$La2",null,{"code":"HTTP/1.1 204 No Content\n"}]}]]}] bb:T5fe,POST /api/subscription-plans HTTP/1.1 Host: merchant.revolut.com Authorization: Bearer sk_abcdef12347890_... Revolut-Api-Version: 2026-08-17 Content-Type: application/json { "name": "Team plan", "variations": [ { "phases": [ { "ordinal": 1, "cycle_duration": "P1M", "amount": 7500, "currency": "GBP", "subscription_items": [ { "type": "flat", "name": "Team seats", "unit": "seat", "quantity": 5, "amount": 1500, "currency": "GBP" } ] } ] }, { "phases": [ { "ordinal": 1, "cycle_duration": "P1M", "amount": 15000, "currency": "GBP", "subscription_items": [ { "type": "flat", "name": "Team seats", "unit": "seat", "quantity": 10, "amount": 1500, "currency": "GBP" } ] } ] }, { "phases": [ { "ordinal": 1, "cycle_duration": "P1M", "subscription_items": [ { "type": "usage", "name": "Active seats", "unit": "seat", "code": "active_seats", "usage_aggregation_method": "latest", "amount": 1500, "currency": "GBP" } ] } ] } ] } a6:["$","div",null,{"className":"wzy01m1","children":["$","$La2",null,{"code":"$bb"}]}] a8:["$","div",null,{"className":"wzy01m1","children":["$","$La2",null,{"code":"POST /api/subscriptions HTTP/1.1\nHost: merchant.revolut.com\nAuthorization: Bearer sk_abcdef12347890_...\nRevolut-Api-Version: 2026-08-17\nContent-Type: application/json\nIdempotency-Key: 916b2ee5-a6bf-441d-9077-e4b9fc93c5ba\n\n{\n \"plan_variation_id\": \"993236c2-fd84-4b1f-b90a-f9691537beb8\",\n \"customer_id\": \"650e8400-e29b-41d4-a716-446655440001\",\n \"external_reference\": \"team_3f9a2c\",\n \"setup_order_redirect_url\": \"https://example.com/subscription/complete\"\n}\n"}]}] aa:["$","div",null,{"className":"wzy01m1","children":["$","$La2",null,{"code":"{\n \"id\": \"c33e76eb-bc87-4f4d-a56b-88c2a069268d\",\n \"external_reference\": \"team_3f9a2c\",\n \"state\": \"pending\",\n \"customer_id\": \"650e8400-e29b-41d4-a716-446655440001\",\n \"plan_id\": \"4fe4870c-f968-42dc-b2fb-6ac4ac9cbb87\",\n \"plan_variation_id\": \"993236c2-fd84-4b1f-b90a-f9691537beb8\",\n \"payment_method_type\": \"automatic\",\n \"created_at\": \"2026-01-26T09:15:00.036001Z\",\n \"updated_at\": \"2026-01-26T09:15:00.036001Z\",\n \"setup_order_id\": \"22425f3b-ac69-4c97-add5-905c4dc831fd\",\n \"current_cycle_id\": \"055f3a58-89d8-4a45-ac95-cbf27e053f2d\"\n}\n"}]}] af:["$","div",null,{"className":"wzy01m1","children":["$","$La2",null,{"code":"{\n \"id\": \"c33e76eb-bc87-4f4d-a56b-88c2a069268d\",\n \"external_reference\": \"team_3f9a2c\",\n \"state\": \"active\",\n \"customer_id\": \"650e8400-e29b-41d4-a716-446655440001\",\n \"plan_id\": \"4fe4870c-f968-42dc-b2fb-6ac4ac9cbb87\",\n \"plan_variation_id\": \"993236c2-fd84-4b1f-b90a-f9691537beb8\",\n \"payment_method_type\": \"automatic\",\n \"payment_method_id\": \"92e6646e-8202-4ab6-816e-7fbbce66f4a7\",\n \"created_at\": \"2026-01-26T09:15:00.036001Z\",\n \"updated_at\": \"2026-01-26T09:20:00.036001Z\",\n \"start_date\": \"2026-01-26T09:20:00.036001Z\",\n \"current_cycle_id\": \"055f3a58-89d8-4a45-ac95-cbf27e053f2d\"\n}\n"}]}] b1:["$","div",null,{"className":"wzy01m1","children":["$","$La2",null,{"code":"POST /api/subscription-usages HTTP/1.1\nHost: merchant.revolut.com\nAuthorization: Bearer sk_abcdef12347890_...\nRevolut-Api-Version: 2026-08-17\nContent-Type: application/json\nIdempotency-Key: a5e687aa-251e-47e5-b2b0-cd6a773b7097\n\n{\n \"subscription_id\": \"beebf6fb-f887-4bcf-af78-d46c7be5825f\",\n \"subscription_item_code\": \"active_seats\",\n \"usage_date\": \"2026-02-15T09:30:00Z\",\n \"quantity\": 12\n}\n"}]}] bc:T434,{ "cycles": [ { "id": "004c9dd4-434c-44be-af4e-8d3c8f9864a6", "subscription_id": "c33e76eb-bc87-4f4d-a56b-88c2a069268d", "plan_variation_id": "993236c2-fd84-4b1f-b90a-f9691537beb8", "plan_variation_phase_id": "3de61e3f-c665-4627-b865-dc0980578cbc", "number": 2, "previous_cycle_id": "055f3a58-89d8-4a45-ac95-cbf27e053f2d", "state": "active", "start_date": "2026-02-26T09:20:00.036001Z", "end_date": "2026-03-26T09:20:00.036001Z", "order_id": "30b9d75b-08f1-4de8-a431-25627f691493", "trial": false }, { "id": "055f3a58-89d8-4a45-ac95-cbf27e053f2d", "subscription_id": "c33e76eb-bc87-4f4d-a56b-88c2a069268d", "plan_variation_id": "993236c2-fd84-4b1f-b90a-f9691537beb8", "plan_variation_phase_id": "3de61e3f-c665-4627-b865-dc0980578cbc", "number": 1, "state": "finished", "start_date": "2026-01-26T09:20:00.036001Z", "end_date": "2026-02-26T09:20:00.036001Z", "order_id": "22425f3b-ac69-4c97-add5-905c4dc831fd", "trial": false } ] } b6:["$","div",null,{"className":"wzy01m1","children":["$","$La2",null,{"code":"$bc"}]}] b9:["$","div",null,{"className":"wzy01m1","children":["$","$La2",null,{"code":"{\n \"id\": \"004c9dd4-434c-44be-af4e-8d3c8f9864a6\",\n \"subscription_id\": \"c33e76eb-bc87-4f4d-a56b-88c2a069268d\",\n \"plan_variation_id\": \"993236c2-fd84-4b1f-b90a-f9691537beb8\",\n \"plan_variation_phase_id\": \"3de61e3f-c665-4627-b865-dc0980578cbc\",\n \"number\": 2,\n \"previous_cycle_id\": \"055f3a58-89d8-4a45-ac95-cbf27e053f2d\",\n \"state\": \"active\",\n \"start_date\": \"2026-02-26T09:20:00.036001Z\",\n \"end_date\": \"2026-03-26T09:20:00.036001Z\",\n \"order_id\": \"30b9d75b-08f1-4de8-a431-25627f691493\",\n \"trial\": false\n}\n"}]}] bd:T3e6b,
{
  "id": "4fe4870c-f968-42dc-b2fb-6ac4ac9cbb87",
  "name": "Team plan",
  "state": "active",
  "created_at": "2026-01-26T08:59:09.433527Z",
  "updated_at": "2026-01-26T08:59:09.433527Z",
  "variations": [
    {
      "id": "993236c2-fd84-4b1f-b90a-f9691537beb8",
      "phases": [
        {
          "id": "3de61e3f-c665-4627-b865-dc0980578cbc",
          "ordinal": 1,
          "cycle_duration": "P1M",
          "amount": 7500,
          "currency": "GBP",
          "subscription_items": [
            {
              "id": "c7a612e6-340e-4f0e-82bf-b1b0af58dc4d",
              "type": "flat",
              "name": "Team seats",
              "unit": "seat",
              "quantity": 5,
              "amount": 1500,
              "currency": "GBP"
            }
          ]
        }
      ]
    },
    {
      "id": "72222cd7-87d5-408b-b604-880a6ac59451",
      "phases": [
        {
          "id": "7bebc04a-b140-444b-915e-5a8fcd9c6145",
          "ordinal": 1,
          "cycle_duration": "P1M",
          "amount": 15000,
          "currency": "GBP",
          "subscription_items": [
            {
              "id": "56a2ee59-a864-45d4-8a3d-1c231136f3bb",
              "type": "flat",
              "name": "Team seats",
              "unit": "seat",
              "quantity": 10,
              "amount": 1500,
              "currency": "GBP"
            }
          ]
        }
      ]
    },
    {
      "id": "d62c249c-4f3f-49b5-adc5-f2678e24f30a",
      "phases": [
        {
          "id": "fb26e30e-4aaa-4639-ac79-e1db418703a4",
          "ordinal": 1,
          "cycle_duration": "P1M",
          "subscription_items": [
            {
              "id": "01e2ff5b-99f5-44e4-acac-2ae15aed4f95",
              "type": "usage",
              "name": "Active seats",
              "unit": "seat",
              "code": "active_seats",
              "usage_aggregation_method": "latest",
              "amount": 1500,
              "currency": "GBP"
            }
          ]
        }
      ]
    }
  ]
}
99:["$","div","CodeBlock-0",{"className":"wzy01m0 _18b50nc0","children":[[["$","div",null,{"className":"_18b50nc1","children":["$","span",null,{"className":"_18b50nc2","children":[false,"Response example"]}]}],["$","$La4",null,{"className":"_18b50nc3","defaultWrap":false,"children":["$","div",null,{"className":"_18b50nc4 _18b50nc5","dangerouslySetInnerHTML":{"__html":"$bd"}}]}]],"$Lbe"]}] bf:T7ec,{ "id": "4fe4870c-f968-42dc-b2fb-6ac4ac9cbb87", "name": "Team plan", "state": "active", "created_at": "2026-01-26T08:59:09.433527Z", "updated_at": "2026-01-26T08:59:09.433527Z", "variations": [ { "id": "993236c2-fd84-4b1f-b90a-f9691537beb8", "phases": [ { "id": "3de61e3f-c665-4627-b865-dc0980578cbc", "ordinal": 1, "cycle_duration": "P1M", "amount": 7500, "currency": "GBP", "subscription_items": [ { "id": "c7a612e6-340e-4f0e-82bf-b1b0af58dc4d", "type": "flat", "name": "Team seats", "unit": "seat", "quantity": 5, "amount": 1500, "currency": "GBP" } ] } ] }, { "id": "72222cd7-87d5-408b-b604-880a6ac59451", "phases": [ { "id": "7bebc04a-b140-444b-915e-5a8fcd9c6145", "ordinal": 1, "cycle_duration": "P1M", "amount": 15000, "currency": "GBP", "subscription_items": [ { "id": "56a2ee59-a864-45d4-8a3d-1c231136f3bb", "type": "flat", "name": "Team seats", "unit": "seat", "quantity": 10, "amount": 1500, "currency": "GBP" } ] } ] }, { "id": "d62c249c-4f3f-49b5-adc5-f2678e24f30a", "phases": [ { "id": "fb26e30e-4aaa-4639-ac79-e1db418703a4", "ordinal": 1, "cycle_duration": "P1M", "subscription_items": [ { "id": "01e2ff5b-99f5-44e4-acac-2ae15aed4f95", "type": "usage", "name": "Active seats", "unit": "seat", "code": "active_seats", "usage_aggregation_method": "latest", "amount": 1500, "currency": "GBP" } ] } ] } ] } be:["$","div",null,{"className":"wzy01m1","children":["$","$La2",null,{"code":"$bf"}]}]