1:I["8f048adc2ca3",[],"StyleSheetProvider",1] 2:I["911c8e14a321",[],"RevpressProvider",1] 3:I["b0b3943575f9",[],"Link",1] 6:I["98d563c3c055",[],"ToastProvider",1] 7:I["9ab2c8c971c4",[],"LayoutTopNav",1] 8:I["3c81c6443917",[],"LayoutMenu",1] 9:I["741b00e3790d",[],"AIToolbar",1] b:I["cc1bdf5ea256",[],"FloatingTableOfContents",1] c:I["98d563c3c055",[],"Spacer",1] d:I["34a8762a918d",[],"Feedback",1] e:I["98d563c3c055",[],"Item",1] f:I["52683481a7bd",[],"ItemContent",1] 10:I["52683481a7bd",[],"ItemTitle",1] 11:I["52683481a7bd",[],"ItemDescription",1] 12:I["7726099d401e",[],"LayoutFeed",1] 13:I["cc1bdf5ea256",[],"TableOfContents",1] 14:I["98d563c3c055",[],"ToastContainer",1] 17:I["29504dfc1207",[],"ErrorBoundary",1] 18:I["98d563c3c055",[],"Box",1] 19:I["98d563c3c055",[],"StatusWidget",1] 1a:I["52683481a7bd",[],"StatusWidgetImage",1] 1b:I["52683481a7bd",[],"StatusWidgetTitle",1] 1c:I["52683481a7bd",[],"StatusWidgetDescription",1] 1d:I["9083c63ad443",[],"CopyAnchor",1] 1e:I["98d563c3c055",[],"Icon",1] 73:I["98d563c3c055",[],"Link",1] 74:I["50460d952402",[],"ScrollArea",1] 75:I["669a0b877249",[],"CopyButton",1] :HL["/_assets/request-fV1VI2Mp.css","stylesheet"] :HL["https://storage.googleapis.com/revolut-prod-apps_cdn/Brand/Retail/Logos/Wordmark/Revolut_Black.svg","image"] :HL["https://storage.googleapis.com/revolut-prod-apps_cdn/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.8.1"}],["$","meta",null,{"property":"og:site_name","content":"Developer"}],["$","meta",null,{"property":"og:type","content":"website"}]],[["$","link","css:/_assets/request-fV1VI2Mp.css",{"rel":"stylesheet","precedence":"vite-rsc/importer-resources","href":"/_assets/request-fV1VI2Mp.css","data-rsc-css-href":"/_assets/request-fV1VI2Mp.css"}],"$undefined"],["$","script",null,{"src":"/_assets/theme-init-add2a6d7.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,{"children":["$","$L2",null,{"nav":[{"item":{"id":"Guides","title":"Guides","items":[{"id":"/docs/guides/merchant/introduction","title":"Merchant","use":"$3","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":"$3","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":"$3","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":"$3","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":"$3","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":"$3","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":"$3","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":"$3","to":"/docs/guides/merchant/accept-payments/online-payments/sepa-direct-debit/introduction","scope":"/docs/guides/merchant"},{"id":"/docs/guides/merchant/accept-payments/no-code/plugins/introduction","title":"Plugins and integrations","use":"$3","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":"$3","to":"/docs/guides/merchant/accept-payments/in-person-payments/introduction","scope":"/docs/guides/merchant"}]},{"id":"/docs/guides/manage-accounts/introduction","title":"Business","use":"$3","to":"/docs/guides/manage-accounts/introduction","scope":"/docs/guides/manage-accounts","items":[{"id":"/docs/guides/manage-accounts/transfers/send-money","title":"Send money","use":"$3","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":"$3","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":"$3","to":"/docs/guides/manage-accounts/exchange-money","scope":"/docs/guides/manage-accounts"},{"id":"/docs/guides/manage-accounts/cards/manage-cards","title":"Manage cards","use":"$3","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":"$3","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":"$3","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":"$3","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":"$3","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":"$3","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":"$3","to":"/docs/guides/crypto-ramp/get-started/integrate-with-revolut-ramp","scope":"/docs/guides/crypto-ramp"}]},{"id":"/docs/guides/revolut-wallet/introduction","title":"Revolut Wallet","use":"$3","to":"/docs/guides/revolut-wallet/introduction","scope":"/docs/guides/revolut-wallet","items":[{"id":"/docs/guides/revolut-wallet/get-started","title":"Get started","use":"$3","to":"/docs/guides/revolut-wallet/get-started","scope":"/docs/guides/revolut-wallet"},{"id":"/docs/guides/revolut-wallet/operations/create-pass","title":"Create a pass","use":"$3","to":"/docs/guides/revolut-wallet/operations/create-pass","scope":"/docs/guides/revolut-wallet"},{"id":"/docs/guides/revolut-wallet/operations/update-pass","title":"Update a pass","use":"$3","to":"/docs/guides/revolut-wallet/operations/update-pass","scope":"/docs/guides/revolut-wallet"},{"id":"/docs/guides/revolut-wallet/operations/transaction-results","title":"Transaction results","use":"$3","to":"/docs/guides/revolut-wallet/operations/transaction-results","scope":"/docs/guides/revolut-wallet"}]}]}},{"item":{"id":"APIs","title":"APIs","items":[{"id":"/docs/api/merchant","title":"Merchant API","use":"$3","to":"/docs/api/merchant","items":[{"id":"/docs/api/merchant#tag-orders","title":"Orders","use":"$3","to":"/docs/api/merchant#tag-orders"},{"id":"/docs/api/merchant#tag-customers","title":"Customers","use":"$3","to":"/docs/api/merchant#tag-customers"},{"id":"/docs/api/merchant#tag-payments","title":"Payments","use":"$3","to":"/docs/api/merchant#tag-payments"},{"id":"/docs/api/merchant#tag-subscriptions","title":"Subscriptions","use":"$3","to":"/docs/api/merchant#tag-subscriptions"},{"id":"/docs/api/merchant#tag-payouts","title":"Payouts","use":"$3","to":"/docs/api/merchant#tag-payouts"},{"id":"/docs/api/merchant#tag-disputes","title":"Disputes","use":"$3","to":"/docs/api/merchant#tag-disputes"},{"id":"/docs/api/merchant#tag-report-runs","title":"Report runs","use":"$3","to":"/docs/api/merchant#tag-report-runs"},{"id":"/docs/api/merchant#tag-webhooks","title":"Webhooks","use":"$3","to":"/docs/api/merchant#tag-webhooks"},{"id":"/docs/api/merchant#tag-locations","title":"Locations","use":"$3","to":"/docs/api/merchant#tag-locations"}]},{"id":"/docs/api/business","title":"Business API","use":"$3","to":"/docs/api/business","items":[{"id":"/docs/api/business#tag-accounting","title":"Accounting settings","use":"$3","to":"/docs/api/business#tag-accounting"},{"id":"/docs/api/business#tag-accounts","title":"Accounts","use":"$3","to":"/docs/api/business#tag-accounts"},{"id":"/docs/api/business#tag-cards","title":"Cards","use":"$3","to":"/docs/api/business#tag-cards"},{"id":"/docs/api/business#tag-counterparties","title":"Counterparties","use":"$3","to":"/docs/api/business#tag-counterparties"},{"id":"/docs/api/business#tag-expenses","title":"Expenses","use":"$3","to":"/docs/api/business#tag-expenses"},{"id":"/docs/api/business#tag-foreign-exchange","title":"Foreign exchange","use":"$3","to":"/docs/api/business#tag-foreign-exchange"},{"id":"/docs/api/business#tag-payment-drafts","title":"Payment drafts","use":"$3","to":"/docs/api/business#tag-payment-drafts"},{"id":"/docs/api/business#tag-payout-links","title":"Payout links","use":"$3","to":"/docs/api/business#tag-payout-links"},{"id":"/docs/api/business#tag-teams","title":"Teams","use":"$3","to":"/docs/api/business#tag-teams"},{"id":"/docs/api/business#tag-transactions","title":"Transactions","use":"$3","to":"/docs/api/business#tag-transactions"},{"id":"/docs/api/business#tag-transfers","title":"Transfers","use":"$3","to":"/docs/api/business#tag-transfers"},{"id":"/docs/api/business#tag-webhooks-v2","title":"Webhooks","use":"$3","to":"/docs/api/business#tag-webhooks-v2"}]},{"id":"/docs/api/open-banking","title":"Open Banking API","use":"$3","to":"/docs/api/open-banking","items":[{"id":"/docs/api/open-banking#tag-accounts","title":"Accounts","use":"$3","to":"/docs/api/open-banking#tag-accounts"},{"id":"/docs/api/open-banking#tag-applications","title":"Applications","use":"$3","to":"/docs/api/open-banking#tag-applications"},{"id":"/docs/api/open-banking#tag-domestic-payment","title":"Payments","use":"$3","to":"/docs/api/open-banking#tag-domestic-payment"},{"id":"/docs/api/open-banking#tag-transactions","title":"Transactions","use":"$3","to":"/docs/api/open-banking#tag-transactions"}]},{"id":"/docs/api/crypto-ramp","title":"Crypto Ramp API","use":"$3","to":"/docs/api/crypto-ramp","items":[{"id":"/docs/api/crypto-ramp#tag-partners","title":"Partners","use":"$3","to":"/docs/api/crypto-ramp#tag-partners"},{"id":"/docs/api/crypto-ramp#tag-webhooks","title":"Webhooks","use":"$3","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":"$3","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":"$3","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":"$3","to":"/docs/api/revolut-x-crypto-exchange"}]},{"id":"/docs/api/revolut-wallet-partner","title":"Revolut Wallet APIs","use":"$3","to":"/docs/api/revolut-wallet-partner","items":[{"id":"/docs/api/revolut-wallet-partner","title":"Partner API","use":"$3","to":"/docs/api/revolut-wallet-partner"},{"id":"/docs/api/revolut-wallet-callbacks","title":"Partner callbacks API","use":"$3","to":"/docs/api/revolut-wallet-callbacks"}]}]}},{"item":{"id":"SDKs","title":"SDKs","items":[{"id":"/docs/sdks/merchant-web-sdk/introduction","title":"Merchant Web SDKs","use":"$3","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":"$3","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":"$3","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":"$3","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":"$3","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":"$3","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/card-field","title":"Card field","use":"$3","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":"$3","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":"$3","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":"$3","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":"$3","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":"$3","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":"$3","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":"$3","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":"$3","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":"$3","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":"$3","to":"/docs/sdks/merchant-android-sdk/revolut-card-form-android-sdk/introduction","scope":"/docs/sdks/merchant-android-sdk"}]}]}},{"item":{"id":"Resources","title":"Resources","items":[{"id":"/docs/resources/marketing-guidelines","title":"Revolut Pay marketing assets and guidelines","use":"$3","to":"/docs/resources/marketing-guidelines","scope":"/docs/resources"},{"id":"/docs/resources/revolut-pay-button-guidelines","title":"Revolut Pay button guidelines","use":"$3","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":"$3","to":"/docs/resources/open-banking-logo-guidelines","scope":"/docs/resources"}]}},{"item":{"id":"More","title":"More","items":[{"id":"/blog","title":"Blog","use":"$3","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":"$3","items":[{"id":"/docs/guides","title":"Guides","use":"$3","items":[]},{"id":"/docs/sdks","title":"Sdks","use":"$3","items":[]}]},{"id":"/docs/guides/build-banking-apps","title":"Build Banking Apps","use":"$3","root":true,"items":[{"id":"/docs/guides/build-banking-apps/introduction-to-the-open-banking-api","title":"Introduction to the Open Banking API","use":"$3","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":"$3"},{"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":"$3"},{"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":"$3"}]},{"id":"/docs/guides/build-banking-apps/get-started","title":"Get started","use":"$3","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":"$3"},{"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":"$3"},{"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":"$3"},{"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":"$3"}]},{"id":"/docs/guides/build-banking-apps/register-your-application-using-dcr","title":"Register your application using DCR","use":"$3","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":"$3"},{"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":"$3"},{"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":"$3"},{"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":"$3"},{"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":"$3"},{"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":"$3"},{"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":"$3"}]},{"id":"/docs/guides/build-banking-apps/manage-your-applications","title":"Manage your applications","use":"$3","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":"$3"},{"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":"$3"},{"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":"$3"},{"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":"$3"}]},{"id":"/docs/guides/build-banking-apps/tutorials","title":"Tutorials","use":"$3","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":"$3"},{"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":"$3"},{"id":"/docs/guides/build-banking-apps/tutorials/test-with-postman","title":"Test with Postman","use":"$3","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":"$3"},{"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":"$3"},{"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":"$3"}]},{"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":"$3"},{"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":"$3"},{"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":"$3"},{"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":"$3"},{"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":"$3"}]},{"id":"/docs/guides/build-banking-apps/api-metrics","title":"API metrics","to":"/docs/guides/build-banking-apps/api-metrics","use":"$3"},{"id":"/docs/guides/build-banking-apps/usage-and-limits","title":"Usage and limits","to":"/docs/guides/build-banking-apps/usage-and-limits","use":"$3"},{"id":"/docs/guides/build-banking-apps/glossary","title":"Glossary","to":"/docs/guides/build-banking-apps/glossary","use":"$3"},{"id":"/docs/guides/build-banking-apps/faqs","title":"FAQs","to":"/docs/guides/build-banking-apps/faqs","use":"$3"},{"id":"/docs/guides/build-banking-apps/errors","title":"Errors","to":"/docs/guides/build-banking-apps/errors","use":"$3"}]},{"id":"/docs/guides/crypto-ramp","title":"Crypto Ramp","use":"$3","root":true,"items":[{"id":"/docs/guides/crypto-ramp/introduction-to-revolut-ramp","title":"Introduction to Revolut Ramp","use":"$3","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":"$3"},{"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":"$3"},{"id":"/docs/guides/crypto-ramp/introduction-to-revolut-ramp/coverage-and-other-details","title":"Coverage and other details","use":"$3","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":"$3"},{"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":"$3"},{"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":"$3"},{"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":"$3"}]},{"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":"$3"},{"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":"$3"}]},{"id":"/docs/guides/crypto-ramp/get-started","title":"Get started","use":"$3","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":"$3"},{"id":"/docs/guides/crypto-ramp/get-started/initiate-transaction","title":"Initiate a transaction","to":"/docs/guides/crypto-ramp/get-started/initiate-transaction","use":"$3"},{"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":"$3"}]},{"id":"/docs/guides/crypto-ramp/tutorials","title":"API usage and testing","use":"$3","items":[{"id":"/docs/guides/crypto-ramp/tutorials/test-the-integration","title":"Test the integration","to":"/docs/guides/crypto-ramp/tutorials/test-the-integration","use":"$3"},{"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":"$3"},{"id":"/docs/guides/crypto-ramp/tutorials/work-with-webhooks","title":"Work with webhooks","use":"$3","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":"$3"},{"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":"$3"}]}]},{"id":"/docs/guides/crypto-ramp/glossary","title":"Glossary","to":"/docs/guides/crypto-ramp/glossary","use":"$3"}]},{"id":"/docs/guides/exchange-fix-api","title":"Exchange FIX API","use":"$3","root":true,"items":[{"id":"/docs/guides/exchange-fix-api/introduction-to-the-exchange-fix-api","title":"Introduction to the Revolut Exchange FIX API","use":"$3","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":"$3"},{"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":"$3"},{"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":"$3"}]},{"id":"/docs/guides/exchange-fix-api/trading-fix-api","title":"Trading FIX API","use":"$3","items":[{"id":"/docs/guides/exchange-fix-api/trading-fix-api/supported-fix-messages","title":"Supported FIX messages","use":"$3","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":"$3"},{"id":"/docs/guides/exchange-fix-api/trading-fix-api/supported-fix-messages/fix-session-level-messages","title":"Session level messages","use":"$3","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":"$3"},{"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":"$3"},{"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":"$3"},{"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":"$3"},{"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":"$3"},{"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":"$3"},{"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":"$3"}]},{"id":"/docs/guides/exchange-fix-api/trading-fix-api/supported-fix-messages/fix-application-level-messages","title":"Application level messages","use":"$3","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":"$3"},{"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":"$3"},{"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":"$3"},{"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":"$3"},{"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":"$3"},{"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":"$3"},{"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":"$3"},{"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":"$3"},{"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":"$3"},{"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":"$3"},{"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":"$3"},{"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":"$3"},{"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":"$3"},{"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":"$3"}]}]}]},{"id":"/docs/guides/exchange-fix-api/market-data-fix-api","title":"Market Data FIX API","use":"$3","items":[{"id":"/docs/guides/exchange-fix-api/market-data-fix-api/supported-fix-messages","title":"Supported FIX messages","use":"$3","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":"$3"},{"id":"/docs/guides/exchange-fix-api/market-data-fix-api/supported-fix-messages/fix-session-level-messages","title":"Session level messages","use":"$3","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":"$3"},{"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":"$3"},{"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":"$3"},{"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":"$3"},{"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":"$3"},{"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":"$3"},{"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":"$3"}]},{"id":"/docs/guides/exchange-fix-api/market-data-fix-api/supported-fix-messages/fix-application-level-messages","title":"Application level messages","use":"$3","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":"$3"},{"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":"$3"},{"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":"$3"},{"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":"$3"},{"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":"$3"},{"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":"$3"},{"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":"$3"}]}]}]},{"id":"/docs/guides/exchange-fix-api/fix-session-management","title":"FIX session management","use":"$3","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":"$3"},{"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":"$3"},{"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":"$3"}]}]},{"id":"/docs/guides/manage-accounts","title":"Manage Accounts","use":"$3","root":true,"items":[{"id":"/docs/guides/manage-accounts/introduction","title":"Introduction to the Business API","to":"/docs/guides/manage-accounts/introduction","use":"$3"},{"id":"/docs/guides/manage-accounts/use-cases","title":"Use cases","use":"$3","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":"$3"},{"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":"$3"},{"id":"/docs/guides/manage-accounts/use-cases/payouts-automation","title":"Payouts automation","to":"/docs/guides/manage-accounts/use-cases/payouts-automation","use":"$3"}]},{"id":"/docs/guides/manage-accounts/get-started","title":"Get started","use":"$3","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":"$3"},{"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":"$3"},{"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":"$3"}]},{"id":"/docs/guides/manage-accounts/accounting","title":"Accounting settings","use":"$3","items":[{"id":"/docs/guides/manage-accounts/accounting/manage-accounting-settings","title":"Overview","to":"/docs/guides/manage-accounts/accounting/manage-accounting-settings","use":"$3"},{"id":"/docs/guides/manage-accounts/accounting/manage-accounting-categories","title":"Accounting categories","to":"/docs/guides/manage-accounts/accounting/manage-accounting-categories","use":"$3"},{"id":"/docs/guides/manage-accounts/accounting/manage-tax-rates","title":"Tax rates","to":"/docs/guides/manage-accounts/accounting/manage-tax-rates","use":"$3"},{"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":"$3"}]},{"id":"/docs/guides/manage-accounts/accounts-and-transactions","title":"Accounts and transactions","use":"$3","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":"$3"},{"id":"/docs/guides/manage-accounts/accounts-and-transactions/retrieve-expenses","title":"Expenses","to":"/docs/guides/manage-accounts/accounts-and-transactions/retrieve-expenses","use":"$3"},{"id":"/docs/guides/manage-accounts/accounts-and-transactions/retrieve-transactions","title":"Transactions","to":"/docs/guides/manage-accounts/accounts-and-transactions/retrieve-transactions","use":"$3"},{"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":"$3"}]},{"id":"/docs/guides/manage-accounts/counterparties","title":"Counterparties","use":"$3","items":[{"id":"/docs/guides/manage-accounts/counterparties/create-a-counterparty","title":"Create a counterparty","to":"/docs/guides/manage-accounts/counterparties/create-a-counterparty","use":"$3"},{"id":"/docs/guides/manage-accounts/counterparties/retrieve-counterparties","title":"Retrieve counterparties","to":"/docs/guides/manage-accounts/counterparties/retrieve-counterparties","use":"$3"},{"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":"$3"},{"id":"/docs/guides/manage-accounts/counterparties/confirmation-of-payee","title":"Confirmation of Payee (CoP)","to":"/docs/guides/manage-accounts/counterparties/confirmation-of-payee","use":"$3"}]},{"id":"/docs/guides/manage-accounts/transfers","title":"Transfers","use":"$3","items":[{"id":"/docs/guides/manage-accounts/transfers/send-money","title":"Send money","to":"/docs/guides/manage-accounts/transfers/send-money","use":"$3"},{"id":"/docs/guides/manage-accounts/transfers/bank-transfers","title":"Bank transfers","to":"/docs/guides/manage-accounts/transfers/bank-transfers","use":"$3"},{"id":"/docs/guides/manage-accounts/transfers/card-transfers","title":"Card transfers","to":"/docs/guides/manage-accounts/transfers/card-transfers","use":"$3"},{"id":"/docs/guides/manage-accounts/transfers/payout-links","title":"Payout links","to":"/docs/guides/manage-accounts/transfers/payout-links","use":"$3"},{"id":"/docs/guides/manage-accounts/transfers/payment-drafts","title":"Payment drafts","to":"/docs/guides/manage-accounts/transfers/payment-drafts","use":"$3"},{"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":"$3"}]},{"id":"/docs/guides/manage-accounts/exchange-money","title":"Foreign exchange","to":"/docs/guides/manage-accounts/exchange-money","use":"$3"},{"id":"/docs/guides/manage-accounts/cards","title":"Cards","use":"$3","items":[{"id":"/docs/guides/manage-accounts/cards/manage-cards","title":"Cards","to":"/docs/guides/manage-accounts/cards/manage-cards","use":"$3"},{"id":"/docs/guides/manage-accounts/cards/manage-card-invitations","title":"Card invitations","to":"/docs/guides/manage-accounts/cards/manage-card-invitations","use":"$3"}]},{"id":"/docs/guides/manage-accounts/teams","title":"Teams","use":"$3","items":[{"id":"/docs/guides/manage-accounts/teams/manage-team-members","title":"Members and roles","to":"/docs/guides/manage-accounts/teams/manage-team-members","use":"$3"},{"id":"/docs/guides/manage-accounts/teams/manage-departments","title":"Departments","to":"/docs/guides/manage-accounts/teams/manage-departments","use":"$3"}]},{"id":"/docs/guides/manage-accounts/webhooks","title":"Webhooks","use":"$3","items":[{"id":"/docs/guides/manage-accounts/webhooks/about-webhooks","title":"About webhooks","to":"/docs/guides/manage-accounts/webhooks/about-webhooks","use":"$3"},{"id":"/docs/guides/manage-accounts/webhooks/manage-webhooks","title":"Manage webhooks","to":"/docs/guides/manage-accounts/webhooks/manage-webhooks","use":"$3"},{"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":"$3"}]},{"id":"/docs/guides/manage-accounts/api-usage-and-testing","title":"API usage and testing","use":"$3","items":[{"id":"/docs/guides/manage-accounts/api-usage-and-testing/errors","title":"Errors","to":"/docs/guides/manage-accounts/api-usage-and-testing/errors","use":"$3"},{"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":"$3"},{"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":"$3"}]}]},{"id":"/docs/guides/merchant","title":"Merchant","use":"$3","root":true,"items":[{"id":"/docs/guides/merchant/introduction","title":"Introduction","to":"/docs/guides/merchant/introduction","use":"$3"},{"id":"/docs/guides/merchant/get-started","title":"Get started","to":"/docs/guides/merchant/get-started","use":"$3"},{"id":"/docs/guides/merchant/test-and-go-live","title":"Test & go live","use":"$3","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":"$3"},{"id":"/docs/guides/merchant/test-and-go-live/testing","title":"Testing","use":"$3","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":"$3"},{"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":"$3"},{"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":"$3"}]}]},{"id":"/docs/guides/merchant/accept-payments","title":"Accept payments","use":"$3","items":[{"id":"/docs/guides/merchant/accept-payments/online-payments","title":"Online payments","use":"$3","items":[{"id":"/docs/guides/merchant/accept-payments/online-payments/revolut-checkout","title":"Revolut Checkout","use":"$3","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":"$3"},{"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":"$3"}]},{"id":"/docs/guides/merchant/accept-payments/online-payments/revolut-pay","title":"Revolut Pay","use":"$3","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":"$3"},{"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":"$3"},{"id":"/docs/guides/merchant/accept-payments/online-payments/revolut-pay/mobile","title":"Mobile","use":"$3","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":"$3"},{"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":"$3"},{"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":"$3"}]},{"id":"/docs/guides/merchant/optimise-checkout/fast-checkout","title":"Fast checkout","use":"$3","to":"/docs/guides/merchant/optimise-checkout/fast-checkout"}]},{"id":"/docs/guides/merchant/accept-payments/online-payments/card-payments","title":"Card payments","use":"$3","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":"$3"},{"id":"/docs/guides/merchant/accept-payments/online-payments/card-payments/web","title":"Web","use":"$3","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":"$3"},{"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":"$3"}]},{"id":"/docs/guides/merchant/accept-payments/online-payments/card-payments/mobile","title":"Mobile","use":"$3","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":"$3"},{"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":"$3"},{"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":"$3"}]}]},{"id":"/docs/guides/merchant/accept-payments/online-payments/apple-pay-google-pay","title":"Apple Pay and Google Pay","use":"$3","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":"$3"},{"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":"$3"},{"id":"/docs/guides/merchant/accept-payments/online-payments/apple-pay-google-pay/mobile","title":"Mobile","use":"$3","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":"$3"}]}]},{"id":"/docs/guides/merchant/accept-payments/online-payments/pay-by-bank","title":"Pay by Bank","use":"$3","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":"$3"},{"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":"$3"}]},{"id":"/docs/guides/merchant/accept-payments/online-payments/sepa-direct-debit","title":"SEPA Direct Debit","use":"$3","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":"$3"},{"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":"$3"}]},{"id":"/docs/guides/merchant/accept-payments/online-payments/hosted-checkout-page","title":"Hosted Checkout Page","use":"$3","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":"$3"},{"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":"$3"},{"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":"$3"}]}]},{"id":"/docs/guides/merchant/accept-payments/in-person-payments","title":"In-person payments","use":"$3","items":[{"id":"/docs/guides/merchant/accept-payments/in-person-payments/introduction","title":"Introduction","to":"/docs/guides/merchant/accept-payments/in-person-payments/introduction","use":"$3"},{"id":"/docs/guides/merchant/accept-payments/in-person-payments/pos","title":"Revolut POS","use":"$3","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":"$3"},{"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":"$3"},{"id":"/docs/guides/merchant/accept-payments/in-person-payments/pos/web-app","title":"Web app","use":"$3","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":"$3"},{"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":"$3"},{"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":"$3"},{"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":"$3"},{"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":"$3"}]},{"id":"/docs/guides/merchant/accept-payments/in-person-payments/pos/ios-app","title":"iOS app","use":"$3","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":"$3"},{"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":"$3"},{"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":"$3"},{"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":"$3"},{"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":"$3"},{"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":"$3"},{"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":"$3"}]},{"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":"$3"},{"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":"$3"},{"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":"$3"}]},{"id":"/docs/guides/merchant/accept-payments/in-person-payments/terminal","title":"Revolut Terminal","use":"$3","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":"$3"},{"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":"$3"},{"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":"$3"},{"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":"$3"},{"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":"$3"},{"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":"$3"},{"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":"$3"}]},{"id":"/docs/guides/merchant/accept-payments/in-person-payments/reader","title":"Revolut Reader","use":"$3","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":"$3"},{"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":"$3"},{"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":"$3"},{"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":"$3"},{"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":"$3"},{"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":"$3"}]},{"id":"/docs/guides/merchant/accept-payments/in-person-payments/tap-to-pay","title":"Tap to Pay","use":"$3","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":"$3"},{"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":"$3"},{"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":"$3"}]}]},{"id":"/docs/guides/merchant/accept-payments/no-code","title":"No-code integrations","use":"$3","items":[{"id":"/docs/guides/merchant/accept-payments/no-code/plugins","title":"E-commerce plugins","use":"$3","items":[{"id":"/docs/guides/merchant/accept-payments/no-code/plugins/introduction","title":"Introduction","to":"/docs/guides/merchant/accept-payments/no-code/plugins/introduction","use":"$3"},{"id":"/docs/guides/merchant/accept-payments/no-code/plugins/woocommerce","title":"WooCommerce","use":"$3","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":"$3"},{"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":"$3"},{"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":"$3"},{"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":"$3"}]},{"id":"/docs/guides/merchant/accept-payments/no-code/plugins/prestashop","title":"PrestaShop","use":"$3","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":"$3"},{"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":"$3"},{"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":"$3"},{"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":"$3"}]},{"id":"/docs/guides/merchant/accept-payments/no-code/plugins/magento","title":"Adobe Commerce (Magento 2)","use":"$3","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":"$3"},{"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":"$3"},{"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":"$3"},{"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":"$3"}]},{"id":"/docs/guides/merchant/accept-payments/no-code/plugins/bigcommerce","title":"BigCommerce","use":"$3","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":"$3"},{"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":"$3"},{"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":"$3"},{"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":"$3"}]},{"id":"/docs/guides/merchant/accept-payments/no-code/plugins/shopify","title":"Shopify","use":"$3","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":"$3"},{"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":"$3"},{"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":"$3"},{"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":"$3"}]},{"id":"/docs/guides/merchant/accept-payments/no-code/plugins/opencart","title":"OpenCart","use":"$3","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":"$3"},{"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":"$3"},{"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":"$3"},{"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":"$3"}]}]},{"id":"/docs/guides/merchant/accept-payments/online-payments/hosted-checkout-page/payment-link","title":"Payment links","use":"$3","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":"$3","items":[{"id":"/docs/guides/merchant/accept-payments/no-code/invoices/xero","title":"Xero invoices","use":"$3","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":"$3"},{"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":"$3"}]}]}]}]},{"id":"/docs/guides/merchant/operations","title":"Operations","use":"$3","items":[{"id":"/docs/guides/merchant/operations/capture-and-settlement","title":"Capture & settlement","use":"$3","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":"$3"},{"id":"/docs/guides/merchant/operations/capture-and-settlement/advanced-authorisation","title":"Advanced authorisation","use":"$3","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":"$3"},{"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":"$3"},{"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":"$3"},{"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":"$3"}]}]},{"id":"/docs/guides/merchant/operations/refunds","title":"Refund payments","to":"/docs/guides/merchant/operations/refunds","use":"$3"}]},{"id":"/docs/guides/merchant/optimise-checkout","title":"Optimise checkout","use":"$3","items":[{"id":"/docs/guides/merchant/optimise-checkout/save-payment-methods","title":"Save and charge payment methods","use":"$3","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":"$3"},{"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":"$3"},{"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":"$3"}]},{"id":"/docs/guides/merchant/optimise-checkout/fast-checkout","title":"Fast checkout","to":"/docs/guides/merchant/optimise-checkout/fast-checkout","use":"$3"},{"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":"$3"}]},{"id":"/docs/guides/merchant/monitor-and-observe","title":"Monitor & observe","use":"$3","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":"$3"},{"id":"/docs/guides/merchant/monitor-and-observe/webhooks","title":"Work with webhooks","use":"$3","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":"$3"},{"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":"$3"}]}]},{"id":"/docs/guides/merchant/reference","title":"Reference","use":"$3","items":[{"id":"/docs/guides/merchant/reference/versioning","title":"Versioning","use":"$3","items":[{"id":"/docs/guides/merchant/reference/versioning/api-versions","title":"API versions","to":"/docs/guides/merchant/reference/versioning/api-versions","use":"$3"},{"id":"/docs/guides/merchant/reference/versioning/deprecation-policy","title":"Deprecation policy","to":"/docs/guides/merchant/reference/versioning/deprecation-policy","use":"$3"},{"id":"/docs/guides/merchant/reference/versioning/changelog","title":"Changelog","to":"/docs/guides/merchant/reference/versioning/changelog","use":"$3"}]},{"id":"/docs/api/merchant","title":"API","use":"$3","to":"/docs/api/merchant"},{"id":"/docs/guides/merchant/reference/sdks","title":"SDKs","use":"$3","items":[{"id":"/docs/sdks/merchant-web-sdk/introduction","title":"Web SDK","use":"$3","to":"/docs/sdks/merchant-web-sdk/introduction"},{"id":"/docs/sdks/merchant-ios-sdk/introduction","title":"iOS SDK","use":"$3","to":"/docs/sdks/merchant-ios-sdk/introduction"},{"id":"/docs/sdks/merchant-android-sdk/introduction","title":"Android SDK","use":"$3","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":"$3"},{"id":"/docs/guides/merchant/reference/error-codes","title":"Errors","use":"$3","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":"$3"},{"id":"/docs/guides/merchant/reference/error-codes/decline-reasons","title":"Decline reasons","to":"/docs/guides/merchant/reference/error-codes/decline-reasons","use":"$3"}]},{"id":"/docs/guides/merchant/reference/order-lifecycle","title":"Order and payment lifecycle","to":"/docs/guides/merchant/reference/order-lifecycle","use":"$3"}]},{"id":"/blog","title":"Updates","use":"$3","to":"/blog"}]},{"id":"/docs/guides/revolut-wallet","title":"Revolut Wallet","use":"$3","root":true,"items":[{"id":"/docs/guides/revolut-wallet/introduction","title":"Introduction","to":"/docs/guides/revolut-wallet/introduction","use":"$3"},{"id":"/docs/guides/revolut-wallet/get-started","title":"Get started","to":"/docs/guides/revolut-wallet/get-started","use":"$3"},{"id":"/docs/guides/revolut-wallet/operations","title":"Operations","use":"$3","items":[{"id":"/docs/guides/revolut-wallet/operations/introduction","title":"Introduction","to":"/docs/guides/revolut-wallet/operations/introduction","use":"$3"},{"id":"/docs/guides/revolut-wallet/operations/create-pass","title":"Create a pass","to":"/docs/guides/revolut-wallet/operations/create-pass","use":"$3"},{"id":"/docs/guides/revolut-wallet/operations/update-pass","title":"Update a pass","to":"/docs/guides/revolut-wallet/operations/update-pass","use":"$3"},{"id":"/docs/guides/revolut-wallet/operations/transaction-results","title":"Transaction results","to":"/docs/guides/revolut-wallet/operations/transaction-results","use":"$3"}]}]},{"id":"/docs/resources","title":"Resources","use":"$3","root":true,"items":[{"id":"/docs/resources/marketing-guidelines","title":"Revolut Pay marketing assets and guidelines","to":"/docs/resources/marketing-guidelines","use":"$3"},{"id":"/docs/resources/revolut-pay-button-guidelines","title":"Revolut Pay button guidelines","to":"/docs/resources/revolut-pay-button-guidelines","use":"$3"},{"id":"/docs/resources/open-banking-logo-guidelines","title":"Revolut Open Banking logo assets and guidelines","to":"/docs/resources/open-banking-logo-guidelines","use":"$3"}]},{"id":"/docs/sdks/merchant-android-sdk","title":"Merchant Android SDK","use":"$3","root":true,"items":[{"id":"/docs/sdks/merchant-android-sdk/introduction","title":"Introduction","to":"/docs/sdks/merchant-android-sdk/introduction","use":"$3"},{"id":"/docs/sdks/merchant-android-sdk/revolut-pay-android-sdk","title":"Revolut Pay SDK","use":"$3","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":"$3"},{"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":"$3"}]},{"id":"/docs/sdks/merchant-android-sdk/revolut-card-form-android-sdk","title":"Revolut Card Form SDK","use":"$3","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":"$3"},{"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":"$3"}]}]},{"id":"/docs/sdks/merchant-ios-sdk","title":"Merchant iOS SDK","use":"$3","root":true,"items":[{"id":"/docs/sdks/merchant-ios-sdk/introduction","title":"Introduction","to":"/docs/sdks/merchant-ios-sdk/introduction","use":"$3"},{"id":"/docs/sdks/merchant-ios-sdk/revolut-pay-ios-sdk","title":"Revolut Pay SDK","use":"$3","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":"$3"},{"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":"$3"}]},{"id":"/docs/sdks/merchant-ios-sdk/apple-pay-ios-sdk","title":"Apple Pay SDK","use":"$3","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":"$3"},{"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":"$3"}]},{"id":"/docs/sdks/merchant-ios-sdk/tap-to-pay-sdk","title":"Tap to Pay SDK","use":"$3","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":"$3"},{"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":"$3"}]},{"id":"/docs/sdks/merchant-ios-sdk/revolut-card-form-ios-sdk","title":"Revolut Card Form SDK","use":"$3","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":"$3"},{"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":"$3"}]}]},{"id":"/docs/sdks/merchant-web-sdk","title":"Merchant Web SDK","use":"$3","root":true,"items":[{"id":"/docs/sdks/merchant-web-sdk/introduction","title":"Introduction","to":"/docs/sdks/merchant-web-sdk/introduction","use":"$3"},{"id":"/docs/sdks/merchant-web-sdk/get-started","title":"Get started","to":"/docs/sdks/merchant-web-sdk/get-started","use":"$3"},{"id":"/docs/sdks/merchant-web-sdk/initialisation","title":"Initialisation","use":"$3","items":[{"id":"/docs/sdks/merchant-web-sdk/initialisation/token-based","title":"Token-based initialisation","to":"/docs/sdks/merchant-web-sdk/initialisation/token-based","use":"$3"},{"id":"/docs/sdks/merchant-web-sdk/initialisation/direct","title":"Direct initialisation","to":"/docs/sdks/merchant-web-sdk/initialisation/direct","use":"$3"},{"id":"/docs/sdks/merchant-web-sdk/initialisation/payments-module","title":"Payments module initialisation","to":"/docs/sdks/merchant-web-sdk/initialisation/payments-module","use":"$3"},{"id":"/docs/sdks/merchant-web-sdk/initialisation/upsell-module","title":"Upsell module initialisation","to":"/docs/sdks/merchant-web-sdk/initialisation/upsell-module","use":"$3"}]},{"id":"/docs/sdks/merchant-web-sdk/payment-methods","title":"Payment methods","use":"$3","items":[{"id":"/docs/sdks/merchant-web-sdk/payment-methods/introduction","title":"Introduction","to":"/docs/sdks/merchant-web-sdk/payment-methods/introduction","use":"$3"},{"id":"/docs/sdks/merchant-web-sdk/payment-methods/embedded-checkout","title":"Embedded checkout","to":"/docs/sdks/merchant-web-sdk/payment-methods/embedded-checkout","use":"$3"},{"id":"/docs/sdks/merchant-web-sdk/payment-methods/revolut-pay","title":"Revolut Pay","to":"/docs/sdks/merchant-web-sdk/payment-methods/revolut-pay","use":"$3"},{"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":"$3"},{"id":"/docs/sdks/merchant-web-sdk/payment-methods/card-field","title":"Card field","to":"/docs/sdks/merchant-web-sdk/payment-methods/card-field","use":"$3"},{"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":"$3"},{"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":"$3"},{"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":"$3"}]},{"id":"/docs/sdks/merchant-web-sdk/promotional-widgets","title":"Promotional widgets","use":"$3","items":[{"id":"/docs/sdks/merchant-web-sdk/promotional-widgets/introduction","title":"Introduction","to":"/docs/sdks/merchant-web-sdk/promotional-widgets/introduction","use":"$3"},{"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":"$3"},{"id":"/docs/sdks/merchant-web-sdk/promotional-widgets/promotional-banner","title":"Promotional banner","to":"/docs/sdks/merchant-web-sdk/promotional-widgets/promotional-banner","use":"$3"},{"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":"$3"}]},{"id":"/docs/sdks/merchant-web-sdk/types","title":"Types","use":"$3","items":[{"id":"/docs/sdks/merchant-web-sdk/types/introduction","title":"Introduction","to":"/docs/sdks/merchant-web-sdk/types/introduction","use":"$3"},{"id":"/docs/sdks/merchant-web-sdk/types/locale","title":"Locale","to":"/docs/sdks/merchant-web-sdk/types/locale","use":"$3"},{"id":"/docs/sdks/merchant-web-sdk/types/address","title":"Address","to":"/docs/sdks/merchant-web-sdk/types/address","use":"$3"},{"id":"/docs/sdks/merchant-web-sdk/types/customer-details","title":"CustomerDetails","to":"/docs/sdks/merchant-web-sdk/types/customer-details","use":"$3"},{"id":"/docs/sdks/merchant-web-sdk/types/revolut-checkout-error","title":"RevolutCheckoutError","to":"/docs/sdks/merchant-web-sdk/types/revolut-checkout-error","use":"$3"},{"id":"/docs/sdks/merchant-web-sdk/types/validation-error","title":"ValidationError","to":"/docs/sdks/merchant-web-sdk/types/validation-error","use":"$3"}]},{"id":"/docs/sdks/merchant-web-sdk/integration-examples","title":"Integration examples","to":"/docs/sdks/merchant-web-sdk/integration-examples","use":"$3"}]},{"id":"/docs/sdks/reverywhere-web-sdk","title":"RevEverywhere Web SDK","use":"$3","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":"$3"}]},{"id":"/docs/sdks/revolut-id-sdk","title":"(BETA) Revolut ID SDK","use":"$3","root":true,"items":[{"id":"/docs/sdks/revolut-id-sdk/introduction","title":"Introduction","to":"/docs/sdks/revolut-id-sdk/introduction","use":"$3"},{"id":"/docs/sdks/revolut-id-sdk/web","title":"Web","use":"$3","items":[{"id":"/docs/sdks/revolut-id-sdk/web/introduction","title":"Introduction","to":"/docs/sdks/revolut-id-sdk/web/introduction","use":"$3"},{"id":"/docs/sdks/revolut-id-sdk/web/configure-client","title":"Configure client","to":"/docs/sdks/revolut-id-sdk/web/configure-client","use":"$3"},{"id":"/docs/sdks/revolut-id-sdk/web/integrate-sdk","title":"Integrate SDK","use":"$3","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":"$3"},{"id":"/docs/sdks/revolut-id-sdk/web/integrate-sdk/react","title":"React","to":"/docs/sdks/revolut-id-sdk/web/integrate-sdk/react","use":"$3"}]},{"id":"/docs/sdks/revolut-id-sdk/web/code-exchange","title":"Code exchange","to":"/docs/sdks/revolut-id-sdk/web/code-exchange","use":"$3"},{"id":"/docs/sdks/revolut-id-sdk/web/api-reference","title":"API reference","use":"$3","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":"$3"},{"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":"$3"},{"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":"$3"},{"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":"$3"},{"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":"$3"}]}]},{"id":"/docs/sdks/revolut-id-sdk/ios","title":"iOS","use":"$3","items":[{"id":"/docs/sdks/revolut-id-sdk/ios/introduction","title":"Introduction","to":"/docs/sdks/revolut-id-sdk/ios/introduction","use":"$3"},{"id":"/docs/sdks/revolut-id-sdk/ios/integration-guide","title":"Integration guide","to":"/docs/sdks/revolut-id-sdk/ios/integration-guide","use":"$3"},{"id":"/docs/sdks/revolut-id-sdk/ios/code-exchange","title":"Code exchange","to":"/docs/sdks/revolut-id-sdk/ios/code-exchange","use":"$3"},{"id":"/docs/sdks/revolut-id-sdk/ios/api-reference","title":"Methods and parameters","use":"$3","to":"/docs/sdks/revolut-id-sdk/ios/api-reference","items":[]}]},{"id":"/docs/sdks/revolut-id-sdk/android","title":"Android","use":"$3","items":[{"id":"/docs/sdks/revolut-id-sdk/android/introduction","title":"Introduction","to":"/docs/sdks/revolut-id-sdk/android/introduction","use":"$3"},{"id":"/docs/sdks/revolut-id-sdk/android/integration-guide","title":"Integration guide","to":"/docs/sdks/revolut-id-sdk/android/integration-guide","use":"$3"},{"id":"/docs/sdks/revolut-id-sdk/android/code-exchange","title":"Code exchange","to":"/docs/sdks/revolut-id-sdk/android/code-exchange","use":"$3"},{"id":"/docs/sdks/revolut-id-sdk/android/methods-parameters","title":"Methods and parameters","to":"/docs/sdks/revolut-id-sdk/android/methods-parameters","use":"$3"}]}]},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk","title":"UI Kit MiniApp Web SDK","use":"$3","root":true,"items":[{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/introduction","title":"Introduction","to":"/docs/sdks/ui-kit-miniapp-web-sdk/introduction","use":"$3"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components","title":"Components","use":"$3","items":[{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Action","title":"Action","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Action","use":"$3"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/ActionButton","title":"ActionButton","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/ActionButton","use":"$3"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Avatar","title":"Avatar","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Avatar","use":"$3"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Badge","title":"Badge","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Badge","use":"$3"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/BottomSheet","title":"BottomSheet","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/BottomSheet","use":"$3"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Button","title":"Button","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Button","use":"$3"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Calendar","title":"Calendar","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Calendar","use":"$3"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Cell","title":"Cell","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Cell","use":"$3"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/CellSkeleton","title":"CellSkeleton","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/CellSkeleton","use":"$3"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Checkbox","title":"Checkbox","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Checkbox","use":"$3"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/CompactInput","title":"CompactInput","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/CompactInput","use":"$3"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Copyable","title":"Copyable","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Copyable","use":"$3"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/DetailsCell","title":"DetailsCell","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/DetailsCell","use":"$3"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Dropdown","title":"Dropdown","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Dropdown","use":"$3"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/FilterButton","title":"FilterButton","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/FilterButton","use":"$3"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Footnote","title":"Footnote","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Footnote","use":"$3"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Group","title":"Group","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Group","use":"$3"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/HStack","title":"HStack","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/HStack","use":"$3"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Icon","title":"Icon","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Icon","use":"$3"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Image","title":"Image","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Image","use":"$3"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Input","title":"Input","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Input","use":"$3"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Link","title":"Link","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Link","use":"$3"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/List","title":"List","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/List","use":"$3"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/MessageBubble","title":"MessageBubble","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/MessageBubble","use":"$3"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Page","title":"Page","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Page","use":"$3"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Placeholder","title":"Placeholder","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Placeholder","use":"$3"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Popup","title":"Popup","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Popup","use":"$3"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/ProgressSteps","title":"ProgressSteps","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/ProgressSteps","use":"$3"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Radio","title":"Radio","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Radio","use":"$3"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/RootProvider","title":"RootProvider","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/RootProvider","use":"$3"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Search","title":"Search","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Search","use":"$3"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Spacer","title":"Spacer","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Spacer","use":"$3"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Subheader","title":"Subheader","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Subheader","use":"$3"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Switch","title":"Switch","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Switch","use":"$3"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/TabBar","title":"TabBar","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/TabBar","use":"$3"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Text","title":"Text","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Text","use":"$3"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/TextArea","title":"TextArea","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/TextArea","use":"$3"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/ToggleButton","title":"ToggleButton","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/ToggleButton","use":"$3"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Toast","title":"Toast","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/Toast","use":"$3"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/VStack","title":"VStack","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/VStack","use":"$3"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/components/VisuallyHidden","title":"VisuallyHidden","to":"/docs/sdks/ui-kit-miniapp-web-sdk/components/VisuallyHidden","use":"$3"}]},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/hooks","title":"Hooks","use":"$3","items":[{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/hooks/useStatusSheet","title":"useStatusSheet","to":"/docs/sdks/ui-kit-miniapp-web-sdk/hooks/useStatusSheet","use":"$3"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/hooks/useToast","title":"useToast","to":"/docs/sdks/ui-kit-miniapp-web-sdk/hooks/useToast","use":"$3"}]},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/constants","title":"Constants","use":"$3","items":[{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/constants/token","title":"Token","to":"/docs/sdks/ui-kit-miniapp-web-sdk/constants/token","use":"$3"}]},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/types","title":"Types","use":"$3","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":"$3"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/types/IconName","title":"IconName","to":"/docs/sdks/ui-kit-miniapp-web-sdk/types/IconName","use":"$3"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/types/NativeButtonProps","title":"NativeButtonProps","to":"/docs/sdks/ui-kit-miniapp-web-sdk/types/NativeButtonProps","use":"$3"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/types/NativeDivProps","title":"NativeDivProps","to":"/docs/sdks/ui-kit-miniapp-web-sdk/types/NativeDivProps","use":"$3"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/types/NativeHeadingProps","title":"NativeHeadingProps","to":"/docs/sdks/ui-kit-miniapp-web-sdk/types/NativeHeadingProps","use":"$3"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/types/NativeMainProps","title":"NativeMainProps","to":"/docs/sdks/ui-kit-miniapp-web-sdk/types/NativeMainProps","use":"$3"},{"id":"/docs/sdks/ui-kit-miniapp-web-sdk/types/NativeSpanProps","title":"NativeSpanProps","to":"/docs/sdks/ui-kit-miniapp-web-sdk/types/NativeSpanProps","use":"$3"}]}]}],"blog":[{"id":"/blog/2026-07-14-tap-to-pay-sdk","title":"New: Tap to Pay SDK for iOS","use":"$3","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 pre-fill","use":"$3","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 Native","use":"$3","to":"/blog/2026-06-02-react-native-merchant-sdks"},{"id":"/blog/2026-05-28-incremental-authorisation-sandbox","title":"Incremental Authorisation: Sandbox testing now available","use":"$3","to":"/blog/2026-05-28-incremental-authorisation-sandbox"},{"id":"/blog/2026-05-06-revolut-checkout-sdk-reference","title":"Revolut Checkout: full SDK reference and shipping options now documented","use":"$3","to":"/blog/2026-05-06-revolut-checkout-sdk-reference"},{"id":"/blog/2026-04-22-merchant-api-version-2026-04-20","title":"New Merchant API version: 2026-04-20","use":"$3","to":"/blog/2026-04-22-merchant-api-version-2026-04-20"},{"id":"/blog/2026-03-14-billing-address-card-payments","title":"Billing address is now required for card payments in the Web SDK","use":"$3","to":"/blog/2026-03-14-billing-address-card-payments"},{"id":"/blog/2026-03-01-hosted-checkout-page","title":"Merchant API: Hosted Checkout Page documentation restructuring","use":"$3","to":"/blog/2026-03-01-hosted-checkout-page"},{"id":"/blog/2026-02-05-incremental-authorisation","title":"New: Incremental Authorisation for card payments","use":"$3","to":"/blog/2026-02-05-incremental-authorisation"},{"id":"/blog/2026-02-01-revolut-checkout","title":"Release announcement: Revolut Checkout","use":"$3","to":"/blog/2026-02-01-revolut-checkout"},{"id":"/blog/2025-12-15-open-banking-minor-updates","title":"Open Banking API: Updates to OpenID config file, account subtype, and DCR scopes","use":"$3","to":"/blog/2025-12-15-open-banking-minor-updates"},{"id":"/blog/2025-12-01-push-payments-to-terminal","title":"Merchant API: Push payments to Revolut Terminal","use":"$3","to":"/blog/2025-12-01-push-payments-to-terminal"},{"id":"/blog/2025-08-15-pay-by-bank-example","title":"New Pay by Bank integration example on GitHub","use":"$3","to":"/blog/2025-08-15-pay-by-bank-example"},{"id":"/blog/2025-07-11-revolut-openapi-github-repository","title":"Revolut APIs: Public API Specs on GitHub","use":"$3","to":"/blog/2025-07-11-revolut-openapi-github-repository"},{"id":"/blog/2025-06-18-new-disputes-endpoints","title":"Merchant API: New Disputes endpoints","use":"$3","to":"/blog/2025-06-18-new-disputes-endpoints"},{"id":"/blog/2025-06-03-apple-pay-unregister","title":"Merchant API: New Apple Pay unregistration endpoint","use":"$3","to":"/blog/2025-06-03-apple-pay-unregister"},{"id":"/blog/2025-05-28-pay-by-bank","title":"Release announcement: Pay by Bank","use":"$3","to":"/blog/2025-05-28-pay-by-bank"},{"id":"/blog/2025-03-19-open-banking-refresh-tokens","title":"Open Banking API Refresh Tokens","use":"$3","to":"/blog/2025-03-19-open-banking-refresh-tokens"},{"id":"/blog/2025-03-04-open-banking-fapi1-advanced","title":"Financial-grade API 1.0 (FAPI 1) Advanced","use":"$3","to":"/blog/2025-03-04-open-banking-fapi1-advanced"},{"id":"/blog/2025-02-03-open-banking-accounts-endpoint","title":"Open Banking API SCA restrictions update","use":"$3","to":"/blog/2025-02-03-open-banking-accounts-endpoint"},{"id":"/blog/2024-09-16-open-banking-ais-restrictions","title":"Restrictions on AIS endpoints","use":"$3","to":"/blog/2024-09-16-open-banking-ais-restrictions"},{"id":"/blog/2024-09-14-open-banking-payment-status","title":"Payment Initiation status update","use":"$3","to":"/blog/2024-09-14-open-banking-payment-status"},{"id":"/blog/2024-08-16-open-banking-migration-of-swiss-users","title":"Migration of Swiss users","use":"$3","to":"/blog/2024-08-16-open-banking-migration-of-swiss-users"}],"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-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-04-20","path":"/docs/api/merchant","latest":true},{"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-04-20","path":"/docs/api/merchant","latest":true},{"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-04-20","path":"/docs/api/merchant","latest":true},{"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-04-20","path":"/docs/api/merchant","latest":true},{"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-04-20","path":"/docs/api/merchant","latest":true},{"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-04-20","path":"/docs/api/merchant","latest":true},{"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-04-20","path":"/docs/api/merchant","latest":true},{"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-04-20","path":"/docs/api/merchant","latest":true},{"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#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-04-20","path":"/docs/api/merchant","latest":true},{"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-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"}}]},{"id":"/docs/api/open-banking#tag-untagged","title":"Untagged","use":"a","href":"#tag-untagged","items":[{"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"}}]}],"versions":"$undefined"},"/docs/api/revolut-wallet-callbacks":{"items":[{"id":"/docs/api/revolut-wallet-callbacks#tag-transaction-outcomes","title":"Transaction outcomes","use":"a","href":"#tag-transaction-outcomes","items":[{"id":"/docs/api/revolut-wallet-callbacks#search-transaction-outcomes","title":"Fetch transaction outcomes for a transaction","use":"a","href":"#search-transaction-outcomes","options":{"method":"post"}}]},{"id":"/docs/api/revolut-wallet-callbacks#tag-passes","title":"Passes","use":"a","href":"#tag-passes","items":[{"id":"/docs/api/revolut-wallet-callbacks#fetch-pass","title":"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-passes","title":"Passes","use":"a","href":"#tag-passes","items":[{"id":"/docs/api/revolut-wallet-partner#create-pass","title":"Create a pass","use":"a","href":"#create-pass","options":{"method":"post"}},{"id":"/docs/api/revolut-wallet-partner#push-pass-update","title":"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 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#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":"Manage team members | Developer"}],["$","meta",null,{"property":"og:title","content":"Manage team members | Developer"}],"$undefined","$undefined",["$","meta",null,{"property":"og:url","content":"https://developer.revolut.com/docs/guides/manage-accounts/teams/manage-team-members"}],[["$","meta",null,{"property":"og:image","content":"https://developer.revolut.com/_assets/og/docs/guides/manage-accounts/teams/manage-team-members.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":["$","$L3",null,{"className":"e43y4a3","to":"/","children":"Home"}]}],["$","li","Manage Accounts-1",{"className":"e43y4a2","children":"Manage Accounts"}],["$","li","Teams-2",{"className":"e43y4a2","children":"Teams"}],["$","li","Members and roles-3",{"className":"e43y4a2","children":null}]]}]}],["$","div",null,{"className":"_10qzu533","children":[[["$","div",null,{"className":"nizrjz0","children":[["$","h1",null,{"className":"nizrjz2","children":"Manage team members"}],["$","div",null,{"className":"nizrjz1","children":"$undefined"}]]}],["$","$L9",null,{"url":"/docs/guides/manage-accounts/teams/manage-team-members.md"}],"$La"],["$","div",null,{"className":"_10qzu534","children":["$","$Lb",null,{"toc":[{"title":"About team members","titleParts":"$undefined","url":"#about-team-members","depth":2},{"title":"Roles","titleParts":"$undefined","url":"#roles","depth":3},{"title":"Manage team members via API","titleParts":"$undefined","url":"#manage-team-members-via-api","depth":2},{"title":"Invite a new member","titleParts":"$undefined","url":"#invite-a-new-member","depth":3},{"title":"Retrieve a list of team members","titleParts":"$undefined","url":"#retrieve-a-list-of-team-members","depth":3},{"title":"Retrieve a team member","titleParts":"$undefined","url":"#retrieve-a-team-member","depth":3},{"title":"Retrieve a list of roles for your business","titleParts":"$undefined","url":"#retrieve-a-list-of-roles-for-your-business","depth":3},{"title":"Filtering and pagination","titleParts":"$undefined","url":"#filtering-and-pagination","depth":3},{"title":"Update a team member's role","titleParts":"$undefined","url":"#update-a-team-members-role","depth":3},{"title":"Assign or remove a department","titleParts":"$undefined","url":"#assign-or-remove-a-department","depth":3},{"title":"Assign or remove a manager","titleParts":"$undefined","url":"#assign-or-remove-a-manager","depth":3},{"title":"Suspend and unsuspend a team member","titleParts":"$undefined","url":"#suspend-and-unsuspend-a-team-member","depth":3},{"title":"Delete a team member","titleParts":"$undefined","url":"#delete-a-team-member","depth":3},{"title":"Sample flow: organisational restructure","titleParts":"$undefined","url":"#sample-flow-organisational-restructure","depth":2},{"title":"What's next","titleParts":"$undefined","url":"#whats-next","depth":2}]}]}]]}],["$","$Lc",null,{}],["$","$Ld","Manage team members",{}],["$","div",null,{"className":"gdnlim0","role":"navigation","data-event-key":"bottom_nav","children":[["$","$Le",null,{"data-shortcut":"[","data-rtl":"$undefined","useIcon":"NavigationBack","use":"$3","to":"/docs/guides/manage-accounts/cards/manage-card-invitations","className":"gdnlim1","children":["$","$Lf",null,{"className":"gdnlim2","children":[["$","$L10",null,{"data-rtl":"$undefined","className":"gdnlim3","children":"Card invitations"}],["$","$L11",null,{"children":"Previous"}]]}]}],["$","$Le",null,{"data-shortcut":"]","data-rtl":true,"useIcon":"NavigationForward","use":"$3","to":"/docs/guides/manage-accounts/teams/manage-departments","className":"gdnlim1","children":["$","$Lf",null,{"className":"gdnlim2","children":[["$","$L10",null,{"data-rtl":true,"className":"gdnlim3","children":"Departments"}],["$","$L11",null,{"children":"Next"}]]}]}]]}]]}],["$","$L12",null,{"children":[["$","$L13",null,{"toc":"$4:6:props:children:props:children:2:0:props:children:1:props:children:1:props:children:props:toc"}],false]}]],["$","div",null,{"className":"wp3eky0","children":["$","$L14",null,{}]}]]}]}]] 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://storage.googleapis.com/revolut-prod-apps_cdn/Brand/Retail/Logos/Wordmark/Revolut_Black.svg","alt":"Revolut"}],["$","img",null,{"data-revpress-display":"dark","className":"_19k157u8","src":"https://storage.googleapis.com/revolut-prod-apps_cdn/Brand/Retail/Logos/Wordmark/Revolut_White.svg","alt":"Revolut"}],[["$","div","0",{"className":"_19k157u4","children":[["$","span",null,{"className":"_19k157u3","children":"Company and products"}],[["$","$L3","0",{"className":"_19k157u5","to":"https://revolut.com/","children":"Discover Revolut"}],["$","$L3","1",{"className":"_19k157u5","to":"https://www.revolut.com/careers/","children":"Join the team!"}],["$","$L3","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"}],[["$","$L3","0",{"className":"_19k157u5","to":"/docs/guides/build-banking-apps/introduction-to-the-open-banking-api/introduction","children":"Documentation"}],["$","$L3","1",{"className":"_19k157u5","to":"/docs/api/open-banking","children":"Open Banking API"}],["$","$L3","2",{"className":"_19k157u5","to":"/docs/guides/build-banking-apps/api-metrics","children":"API Status"}],["$","$L3","3",{"className":"_19k157u5","to":"https://developer.revolut.com/portal/signup","children":"Developer Portal"}],["$","$L3","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"}],[["$","$L3","0",{"className":"_19k157u5","to":"/docs/guides/manage-accounts/introduction","children":"Documentation"}],["$","$L3","1",{"className":"_19k157u5","to":"/docs/api/business","children":"Business API"}]]]}],["$","div","3",{"className":"_19k157u4","children":[["$","span",null,{"className":"_19k157u3","children":"Accept Payments"}],[["$","$L3","0",{"className":"_19k157u5","to":"/docs/guides/merchant/introduction","children":"Documentation"}],["$","$L3","1",{"className":"_19k157u5","to":"/docs/api/merchant","children":"Merchant API"}],["$","$L3","2",{"className":"_19k157u5","to":"/docs/sdks/merchant-web-sdk/introduction","children":"Merchant Web SDKs"}],["$","$L3","3",{"className":"_19k157u5","to":"/docs/sdks/merchant-ios-sdk/introduction","children":"Merchant iOS SDKs"}],["$","$L3","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"}],[["$","$L3","0",{"className":"_19k157u5","to":"/docs/guides/merchant/accept-payments/in-person-payments/introduction","children":"Documentation"}],["$","$L3","1",{"className":"_19k157u5","to":"/docs/guides/merchant/accept-payments/in-person-payments/pos/introduction","children":"Revolut POS"}],["$","$L3","2",{"className":"_19k157u5","to":"https://apps.apple.com/gb/app/revolut-pos/id1604861598","children":"Download the Revolut POS app"}],["$","$L3","3",{"className":"_19k157u5","to":"/docs/guides/merchant/accept-payments/in-person-payments/reader/introduction","children":"Revolut Reader"}],["$","$L3","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."}],"$L15","$L16"]]}]]}]}] 15:["$","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."}] 16:["$","p","2",{"className":"_19k157u7","children":"Revolut's commodities service is not regulated by the FCA."}] a:["$","article",null,{"className":"_8qmzte0","children":["$","$L17","docs/guides/manage-accounts/teams/manage-team-members.md",{"fallback":["$","$L18",null,{"my":"auto","mx":"auto","width":"100%","maxWidth":500,"children":["$","$L19",null,{"children":[["$","$L1a",null,{"icon":"ExclamationTriangle"}],["$","$L1b",null,{"children":"Content could not be rendered"}],["$","$L1c",null,{"maxWidth":320,"children":[null,["$","div",null,{"children":"This content is unavailable."}]]}]]}]}],"children":[null,"\n",["$","p",null,{"children":"Use the Business API to manage team members and their roles."}],"\n",["$","h2",null,{"id":"about-team-members","children":["About team members",["$","$L1d",null,{"id":"about-team-members"}]]}],"\n",["$","p",null,{"children":["Your team means a group of users who have access to your Revolut Business account.\nWhen you ",["$","a",null,{"href":"#invite-a-new-member","children":"invite"}]," people to your business, it means that you add them to this team and assign them a ",["$","a",null,{"href":"#roles","children":"role"}]," in the team."]}],"\n",["$","p",null,{"children":"The invited user receives an email with an invitation link.\nTo join the team, the invitee has to accept the invitation."}],"\n",["$","p",null,{"children":["You can use the API to ",["$","a",null,{"href":"#retrieve-a-list-of-team-members","children":"retrieve the list of your team members"}],"."]}],"\n",["$","h3",null,{"id":"roles","children":["Roles",["$","$L1d",null,{"id":"roles"}]]}],"\n",["$","p",null,{"children":["A role is a defined set of permissions, for example, ",["$","code",null,{"children":"View cards"}],", ",["$","code",null,{"children":"Manage users"}],", etc.\nTeam members can have different roles in your team."]}],"\n",["$","p",null,{"children":["The creator of the business has a special role, ",["$","code",null,{"children":"Owner"}],", which can only be assigned to one team member."]}],"\n",["$","div",null,{"data-type":"note","className":"_25vm6y0","children":[["$","div",null,{"className":"_25vm6y1","children":["$","$L1e",null,{"name":"InfoOutline","color":"var(--rui-color-grey-tone-50)","inline":true}]}],null,["$","div",null,{"className":"_25vm6y3","children":[["$","p",null,{"children":["The ",["$","code",null,{"children":"Owner"}]," role is not transferable unless the existing owner leaves the team."]}],["$","p",null,{"children":"In such a case, this role must be transferred to another team member when terminating the leaving owner's account."}]]}]]}],"\n",["$","p",null,{"children":"All the other roles can be assigned to multiple members.\nHowever, one member can have only one role assigned at a time."}],"\n",["$","p",null,{"children":["All businesses have predefined roles, such as ",["$","code",null,{"children":"Admin"}]," or ",["$","code",null,{"children":"Member"}],", but a business can also add custom roles through the ",["$","a",null,{"href":"https://business.revolut.com","target":"_blank","rel":"noreferrer","children":"Revolut Business app"}],".\nYou can use the API to ",["$","a",null,{"href":"#retrieve-a-list-of-roles-for-your-business","children":"retrieve roles"}]," available for your business together with their IDs."]}],"\n",["$","p",null,{"children":["You decide which role to assign to the user when you ",["$","a",null,{"href":"#invite-a-new-member","children":"invite"}]," them to the team.\nIf you want to change it later, you can do so in the ",["$","a",null,{"href":"https://business.revolut.com","target":"_blank","rel":"noreferrer","children":"Revolut Business app"}]," or via the API using the ",["$","a",null,{"href":"#update-a-team-members-role","children":"Update a team member's role"}]," endpoint."]}],"\n",["$","p",null,{"children":"In the app, you can also see specific permissions assigned to a role, edit permissions, or edit roles."}],"\n",["$","h2",null,{"id":"manage-team-members-via-api","children":["Manage team members via API",["$","$L1d",null,{"id":"manage-team-members-via-api"}]]}],"\n",["$","p",null,{"children":"The Business API lets you:"}],"\n",["$","ul",null,{"children":["\n",["$","li",null,{"children":[["$","a",null,{"href":"#invite-a-new-member","children":"Add team members"}]," to your Revolut Business account and assign them ",["$","a",null,{"href":"#roles","children":"roles"}]]}],"\n",["$","li",null,{"children":["$","a",null,{"href":"#retrieve-a-list-of-team-members","children":"Retrieve the list of added team members"}]}],"\n","$L1f","\n","$L20","\n","$L21","\n","$L22","\n","$L23","\n","$L24","\n","$L25","\n"]}],"\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","$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","$L66","\n","$L67","\n","$L68","\n","$L69","\n","$L6a","\n","$L6b","\n","$L6c","\n","$L6d","\n","$L6e","\n","$L6f","\n","$L70","\n","$L71","\n","$L72"]}]}] 1f:["$","li",null,{"children":[["$","a",null,{"href":"#retrieve-a-team-member","children":"Retrieve a single team member"}]," by ID"]}] 20:["$","li",null,{"children":[["$","a",null,{"href":"#retrieve-a-list-of-roles-for-your-business","children":"Retrieve the list of roles"}]," for your business team members"]}] 21:["$","li",null,{"children":["$","a",null,{"href":"#update-a-team-members-role","children":"Update a team member's role"}]}] 22:["$","li",null,{"children":[["$","a",null,{"href":"#assign-or-remove-a-department","children":"Assign or remove a department"}]," from a team member"]}] 23:["$","li",null,{"children":[["$","a",null,{"href":"#assign-or-remove-a-manager","children":"Assign or remove a manager"}]," for a team member"]}] 24:["$","li",null,{"children":["$","a",null,{"href":"#suspend-and-unsuspend-a-team-member","children":"Suspend or unsuspend team members"}]}] 25:["$","li",null,{"children":["$","a",null,{"href":"#delete-a-team-member","children":"Delete team members"}]}] 26:["$","h3",null,{"id":"invite-a-new-member","children":["Invite a new member",["$","$L1d",null,{"id":"invite-a-new-member"}]]}] 27:["$","p",null,{"children":["To invite a new team member to your Revolut Business account, you must provide their email address and specify the ",["$","a",null,{"href":"#roles","children":"role"}]," that should be assigned to this member."]}] 28:["$","p",null,{"children":"In the response, you get the invited member's ID and email address, the ID of the role that should be assigned to the member and the date-times of creation and last update."}] 29:["$","p",null,{"children":"To see example requests and responses:"}] 2a:["$","p",null,{"children":["$","$L73",null,{"use":"$3","to":"/docs/api/business#invite-team-member","children":"See the API reference: Invite a new member to your business"}]}] 2b:["$","h3",null,{"id":"retrieve-a-list-of-team-members","children":["Retrieve a list of team members",["$","$L1d",null,{"id":"retrieve-a-list-of-team-members"}]]}] 2c:["$","p",null,{"children":["You can list all the team members ",["$","a",null,{"href":"#invite-a-new-member","children":"added"}]," to your Revolut Business account.\nYou can also ",["$","a",null,{"href":"#filtering-and-pagination","children":"filter"}]," the team members by the date they were added to your account."]}] 2d:["$","p",null,{"children":["The results are ",["$","a",null,{"href":"#filtering-and-pagination","children":"paginated"}]," and sorted by the ",["$","code",null,{"children":"created_at"}]," date in reverse chronological order."]}] 2e:["$","p",null,{"children":"In the response, you get the member's details, such as their ID and email address, their first and last name, the state that the team member's user is in, the ID of the role assigned to the team member, and the date-times of creation and last update.\nThe response also includes the IDs of the department and manager assigned to the team member, if present."}] 2f:["$","p",null,{"children":"To see example requests and responses:"}] 30:["$","p",null,{"children":["$","$L73",null,{"use":"$3","to":"/docs/api/business#get-team-members","children":"See the API reference: Retrieve a list of team members"}]}] 31:["$","h3",null,{"id":"retrieve-a-team-member","children":["Retrieve a team member",["$","$L1d",null,{"id":"retrieve-a-team-member"}]]}] 32:["$","p",null,{"children":["To get the details of a specific team member, make a ",["$","code",null,{"children":"GET"}]," request providing the team member's ID."]}] 33:["$","p",null,{"children":"In the response, you get the same member details as in the list endpoint: their ID, email address, first and last name, state, role ID, and the date-times of creation and last update.\nThe response also includes the IDs of the department and manager assigned to the team member, if present."}] 34:["$","p",null,{"children":"To see example requests and responses:"}] 35:["$","p",null,{"children":["$","$L73",null,{"use":"$3","to":"/docs/api/business#get-team-member-by-id","children":"See the API reference: Retrieve a team member"}]}] 36:["$","h3",null,{"id":"retrieve-a-list-of-roles-for-your-business","children":["Retrieve a list of roles for your business",["$","$L1d",null,{"id":"retrieve-a-list-of-roles-for-your-business"}]]}] 37:["$","p",null,{"children":["You can list the roles that can be assigned to a team member of your Revolut Business account.\nYou can also ",["$","a",null,{"href":"#filtering-and-pagination","children":"filter"}]," the roles by the date they were created."]}] 38:["$","p",null,{"children":["The results are ",["$","a",null,{"href":"#filtering-and-pagination","children":"paginated"}]," and sorted by the ",["$","code",null,{"children":"created_at"}]," date in reverse chronological order."]}] 39:["$","p",null,{"children":"In the response, for each role you get its ID, name, and the date-times of creation and last update."}] 3a:["$","p",null,{"children":"To see example requests and responses:"}] 3b:["$","p",null,{"children":["$","$L73",null,{"use":"$3","to":"/docs/api/business#get-roles","children":"See the API reference: Retrieve team roles"}]}] 3c:["$","div",null,{"data-type":"tip","className":"_25vm6y0","children":[["$","div",null,{"className":"_25vm6y1","children":["$","$L1e",null,{"name":"Lightbulb","color":"var(--rui-color-success)","inline":true}]}],null,["$","div",null,{"className":"_25vm6y3","children":["$","p",null,{"children":["Use the ",["$","a",null,{"href":"https://business.revolut.com","target":"_blank","rel":"noreferrer","children":"Revolut Business app"}]," to create custom roles, see specific permissions assigned to a role, and edit permissions and roles."]}]}]]}] 3d:["$","h3",null,{"id":"filtering-and-pagination","children":["Filtering and pagination",["$","$L1d",null,{"id":"filtering-and-pagination"}]]}] 3e:["$","p",null,{"children":["When retrieving ",["$","a",null,{"href":"#retrieve-a-list-of-team-members","children":"team members"}]," or ",["$","a",null,{"href":"#retrieve-a-list-of-roles-for-your-business","children":"roles"}],", you can also include the optional query parameters to:"]}] 3f:["$","ul",null,{"children":["\n",["$","li",null,{"children":["Modify the maximum number of items returned per page (by default, it's ",["$","code",null,{"children":"100"}],")"]}],"\n",["$","li",null,{"children":"Retrieve only the items which were created before a date/date-time that you specify"}],"\n"]}] 40:["$","p",null,{"children":"For example, these parameters limit the number of team members to three and retrieve only the members added before 13th June 2023:"}] 42:["$","p",null,{"children":["To get to the next page, make a new request and use the ",["$","code",null,{"children":"created_at"}]," date of the last returned item as ",["$","code",null,{"children":"created_before"}],"."]}] 43:["$","h3",null,{"id":"update-a-team-members-role","children":["Update a team member's role",["$","$L1d",null,{"id":"update-a-team-members-role"}]]}] 44:["$","p",null,{"children":["To change the role assigned to a team member, make a ",["$","code",null,{"children":"PUT"}]," request providing the team member's ID and the new role ID."]}] 45:["$","div",null,{"data-type":"note","className":"_25vm6y0","children":[["$","div",null,{"className":"_25vm6y1","children":["$","$L1e",null,{"name":"InfoOutline","color":"var(--rui-color-grey-tone-50)","inline":true}]}],null,["$","div",null,{"className":"_25vm6y3","children":["$","p",null,{"children":"You cannot modify the business owner or assign the owner role to another team member."}]}]]}] 46:["$","p",null,{"children":["On success, you get a ",["$","code",null,{"children":"204"}]," response with no additional content."]}] 47:["$","p",null,{"children":"To see example requests and responses:"}] 48:["$","p",null,{"children":["$","$L73",null,{"use":"$3","to":"/docs/api/business#update-team-member-role","children":"See the API reference: Update a team member's role"}]}] 49:["$","h3",null,{"id":"assign-or-remove-a-department","children":["Assign or remove a department",["$","$L1d",null,{"id":"assign-or-remove-a-department"}]]}] 4a:["$","p",null,{"children":["To ",["$","strong",null,{"children":"assign"}]," a department to a team member, make a ",["$","code",null,{"children":"PUT"}]," request providing the team member's ID and the new department ID."]}] 4b:["$","p",null,{"children":"To see example requests and responses:"}] 4c:["$","p",null,{"children":["$","$L73",null,{"use":"$3","to":"/docs/api/business#assign-department","children":"See the API reference: Assign a department to a team member"}]}] 4d:["$","p",null,{"children":["To ",["$","strong",null,{"children":"remove"}]," the department assignment, make a ",["$","code",null,{"children":"DELETE"}]," request to the same endpoint with the team member's ID."]}] 4e:["$","p",null,{"children":"To see example requests and responses:"}] 4f:["$","p",null,{"children":["$","$L73",null,{"use":"$3","to":"/docs/api/business#unassign-department","children":"See the API reference: Remove department from a team member"}]}] 50:["$","p",null,{"children":["On success, you get a ",["$","code",null,{"children":"204"}]," response with no additional content."]}] 51:["$","p",null,{"children":["For more information about managing departments, see ",["$","$L73",null,{"use":"$3","to":"/docs/guides/manage-accounts/teams/manage-departments","children":"Manage departments"}],"."]}] 52:["$","h3",null,{"id":"assign-or-remove-a-manager","children":["Assign or remove a manager",["$","$L1d",null,{"id":"assign-or-remove-a-manager"}]]}] 53:["$","p",null,{"children":["To ",["$","strong",null,{"children":"assign"}]," a manager to a team member, make a ",["$","code",null,{"children":"PUT"}]," request providing the team member's ID and the ",["$","code",null,{"children":"manager_id"}],". The manager must be an existing team member in the same business."]}] 54:["$","p",null,{"children":"To see example requests and responses:"}] 55:["$","p",null,{"children":["$","$L73",null,{"use":"$3","to":"/docs/api/business#assign-manager","children":"See the API reference: Assign a manager to a team member"}]}] 56:["$","p",null,{"children":["To ",["$","strong",null,{"children":"remove"}]," the manager assignment, make a ",["$","code",null,{"children":"DELETE"}]," request to the same endpoint with the team member's ID."]}] 57:["$","p",null,{"children":"To see example requests and responses:"}] 58:["$","p",null,{"children":["$","$L73",null,{"use":"$3","to":"/docs/api/business#unassign-manager","children":"See the API reference: Remove manager from a team member"}]}] 59:["$","p",null,{"children":["On success, you get a ",["$","code",null,{"children":"204"}]," response with no additional content."]}] 5a:["$","h3",null,{"id":"suspend-and-unsuspend-a-team-member","children":["Suspend and unsuspend a team member",["$","$L1d",null,{"id":"suspend-and-unsuspend-a-team-member"}]]}] 5b:["$","p",null,{"children":"Suspending a team member prevents them from accessing your Revolut Business account. You can unsuspend them at any time to restore their access."}] 5c:["$","p",null,{"children":["To ",["$","strong",null,{"children":"suspend"}]," a team member, make a ",["$","code",null,{"children":"POST"}]," request providing the team member's ID."]}] 5d:["$","div",null,{"data-type":"note","className":"_25vm6y0","children":[["$","div",null,{"className":"_25vm6y1","children":["$","$L1e",null,{"name":"InfoOutline","color":"var(--rui-color-grey-tone-50)","inline":true}]}],null,["$","div",null,{"className":"_25vm6y3","children":["$","p",null,{"children":"You cannot suspend the business owner.\nYou cannot suspend or unsuspend a team member who hasn't accepted their invitation yet."}]}]]}] 5e:["$","p",null,{"children":"To see example requests and responses:"}] 5f:["$","p",null,{"children":["$","$L73",null,{"use":"$3","to":"/docs/api/business#suspend-team-member","children":"See the API reference: Suspend a team member"}]}] 60:["$","p",null,{"children":["To ",["$","strong",null,{"children":"unsuspend"}],", use the unsuspend endpoint with the same team member's ID."]}] 61:["$","p",null,{"children":"To see example requests and responses:"}] 62:["$","p",null,{"children":["$","$L73",null,{"use":"$3","to":"/docs/api/business#unsuspend-team-member","children":"See the API reference: Unsuspend a team member"}]}] 63:["$","p",null,{"children":["On success, you get a ",["$","code",null,{"children":"204"}]," response with no additional content."]}] 64:["$","h3",null,{"id":"delete-a-team-member","children":["Delete a team member",["$","$L1d",null,{"id":"delete-a-team-member"}]]}] 65:["$","p",null,{"children":["To delete a team member, you simply make a ",["$","code",null,{"children":"DELETE"}]," call providing this member's ID."]}] 66:["$","p",null,{"children":["On successful deletion, you get a ",["$","code",null,{"children":"204"}]," response with no additional content."]}] 67:["$","p",null,{"children":"To see example requests and responses:"}] 68:["$","p",null,{"children":["$","$L73",null,{"use":"$3","to":"/docs/api/business#delete-team-member","children":"See the API reference: Delete a team member"}]}] 69:["$","h2",null,{"id":"sample-flow-organisational-restructure","children":["Sample flow: organisational restructure",["$","$L1d",null,{"id":"sample-flow-organisational-restructure"}]]}] 6a:["$","p",null,{"children":"The following script demonstrates a full organisational restructure using the Business API.\nIt covers two phases: setting up a new department with a promoted team lead and new hires, then closing a department after employees leave."}] 6b:["$","p",null,{"children":"The script also demonstrates suspending and unsuspending team members: the backfill member was invited in advance but suspended until their start date, and departing members in the closing department are suspended before being removed."}] 6c:["$","p",null,{"children":"Replace the placeholder IDs and names with real values from your business before running it."}] 6e:["$","p",null,{"children":["$","strong",null,{"children":"Sample output:"}]}] 70:["$","div",null,{"data-type":"note","className":"_25vm6y0","children":[["$","div",null,{"className":"_25vm6y1","children":["$","$L1e",null,{"name":"InfoOutline","color":"var(--rui-color-grey-tone-50)","inline":true}]}],null,["$","div",null,{"className":"_25vm6y3","children":["$","p",null,{"children":["The API does not support creating or deleting roles.\nTo create custom roles, edit or delete existing ones, use the ",["$","a",null,{"href":"https://business.revolut.com","target":"_blank","rel":"noreferrer","children":"Revolut Business app"}],"."]}]}]]}] 71:["$","h2",null,{"id":"whats-next","children":["What's next",["$","$L1d",null,{"id":"whats-next"}]]}] 72:["$","ul",null,{"children":["\n",["$","li",null,{"children":["See how to ",["$","$L73",null,{"use":"$3","to":"/docs/guides/manage-accounts/cards/manage-cards","children":"manage cards"}]," for your team."]}],"\n",["$","li",null,{"children":["See how to ",["$","$L73",null,{"use":"$3","to":"/docs/guides/manage-accounts/teams/manage-departments","children":"manage departments"}]," for your team members."]}],"\n"]}] 41:["$","div",null,{"className":"wzy01m0 _18b50nc0","children":[["$undefined",["$","$L74",null,{"className":"_18b50nc3","defaultWrap":false,"children":["$","div",null,{"className":"_18b50nc4","dangerouslySetInnerHTML":{"__html":"
/team-members?limit=3&created_before=2023-06-13
"}}]}]],["$","div",null,{"className":"wzy01m1","children":["$","$L75",null,{"code":"/team-members?limit=3&created_before=2023-06-13\n"}]}]]}] 76:Ta110,
import requests

# =============================================
# Configuration
# =============================================
API_URL = "https://sandbox-b2b.revolut.com/api/1.0"
API_TOKEN = "YOUR_ACCESS_TOKEN"
HEADERS = {"Authorization": f"Bearer {API_TOKEN}", "Content-Type": "application/json"}

# Existing team member being promoted to head the new department
PROMOTED_MEMBER_ID = "11111111-1111-1111-1111-111111111111"
# Their new manager (another existing team member)
NEW_MANAGER_ID = "22222222-2222-2222-2222-222222222222"
# New hire who will backfill the promoted member's previous role
BACKFILL_MEMBER_ID = "33333333-3333-3333-3333-333333333333"
# Department being closed
CLOSING_DEPT_ID = "cccccccc-cccc-cccc-cccc-cccccccccccc"

# Emails of new hires joining the new department
NEW_TEAM_EMAILS = [
    "dana.white@example.com",
    "edward.black@example.com",
    "fiona.green@example.com",
]
NEW_MEMBER_ROLE_ID = "member"     # Retrieve available roles with GET /roles
HEAD_ROLE_ID = "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
NEW_DEPT_NAME = "Platform Engineering"


def api(method, path, body=None):
    """Make an API request and return the JSON response (or None for 204)."""
    resp = requests.request(method, f"{API_URL}{path}", headers=HEADERS, json=body)
    if not resp.ok:
        print(f"ERROR {resp.status_code} {method} {path}: {resp.text}")
    resp.raise_for_status()
    return resp.json() if resp.content else None


def fmt_name(m):
    """Return 'First Last' or fall back to email if names are null."""
    name = f"{m.get('first_name') or ''} {m.get('last_name') or ''}".strip()
    return name or m["email"]


# Build a lookup of role IDs to names
roles = api("GET", "/roles?limit=1000")
role_names = {r["id"]: r["name"] for r in roles}


# =============================================
# Phase 1: New department and team growth
# =============================================
print(f"=== Phase 1: Setting up {NEW_DEPT_NAME} ===")

# 1. Create the new department
dept = api("POST", "/departments", {"name": NEW_DEPT_NAME})
dept_id = dept["id"]
print(f"Created department '{NEW_DEPT_NAME}' with ID: {dept_id}")

# 2. Assign an existing team member to the new department, then promote them to head it
#    Save their current role and department so we can backfill later.
promoted = api("GET", f"/team-members/{PROMOTED_MEMBER_ID}")
previous_role_id = promoted.get("role_id")
previous_dept_id = promoted.get("department_id")

api("PUT", f"/team-members/{PROMOTED_MEMBER_ID}/department", {"department_id": dept_id})
print(f"Assigned {fmt_name(promoted)} to '{NEW_DEPT_NAME}'")

api("PUT", f"/team-members/{PROMOTED_MEMBER_ID}/role", {"role_id": HEAD_ROLE_ID})
print(f"Promoted {fmt_name(promoted)} to {role_names[HEAD_ROLE_ID]}")

manager = api("GET", f"/team-members/{NEW_MANAGER_ID}")
api("PUT", f"/team-members/{PROMOTED_MEMBER_ID}/manager", {"manager_id": NEW_MANAGER_ID})
print(f"Assigned {fmt_name(manager)} as manager to {fmt_name(promoted)}")

# 3. Invite new hires and assign them to the department
for email in NEW_TEAM_EMAILS:
    member = api("POST", "/team-members", {"email": email, "role_id": NEW_MEMBER_ROLE_ID})
    api("PUT", f"/team-members/{member['id']}/department", {"department_id": dept_id})
    api("PUT", f"/team-members/{member['id']}/manager", {"manager_id": PROMOTED_MEMBER_ID})
    print(f"- Invited {email}")
print(f"Invited {len(NEW_TEAM_EMAILS)} team members to '{NEW_DEPT_NAME}'")

# 4. Backfill the promoted member's previous role
#    Unsuspend the backfill member (they were invited but hadn't started yet)
backfill = api("GET", f"/team-members/{BACKFILL_MEMBER_ID}")
api("POST", f"/team-members/{BACKFILL_MEMBER_ID}/unsuspend")
print(f"Unsuspended {fmt_name(backfill)}")

api("PUT", f"/team-members/{BACKFILL_MEMBER_ID}/role", {"role_id": previous_role_id})
if previous_dept_id:
    api("PUT", f"/team-members/{BACKFILL_MEMBER_ID}/department", {"department_id": previous_dept_id})
print(f"Backfilled role '{role_names[previous_role_id]}' with {fmt_name(backfill)} (replacement for {fmt_name(promoted)})")

# =============================================
# Phase 2: Department closure
# =============================================
closing = api("GET", f"/departments/{CLOSING_DEPT_ID}")
print(f"\n=== Phase 2: Closing '{closing['name']}' ===")

# 5. Suspend all team members in the closing department
members = api("GET", "/team-members?limit=1000")
closing_members = [m for m in members if m.get("department_id") == CLOSING_DEPT_ID]
for m in closing_members:
    api("POST", f"/team-members/{m['id']}/suspend")
    print(f"Suspended {fmt_name(m)}")

# 6. Remove suspended members from the department and delete them
for m in closing_members:
    api("DELETE", f"/team-members/{m['id']}/department")
    api("DELETE", f"/team-members/{m['id']}/manager")
    api("DELETE", f"/team-members/{m['id']}")
    print(f"Removed {fmt_name(m)}")

# 7. Delete the department
api("DELETE", f"/departments/{CLOSING_DEPT_ID}")
print(f"Deleted department '{closing['name']}'")
6d:["$","div",null,{"className":"wzy01m0 _18b50nc0","children":[[["$","div",null,{"className":"_18b50nc1","children":["$","span",null,{"className":"_18b50nc2","children":[["$","$L1e",null,{"color":"grey-tone-50","name":"Document","size":16}],"org-restructure.py"]}]}],["$","$L74",null,{"className":"_18b50nc3","defaultWrap":false,"children":["$","div",null,{"className":"_18b50nc4 _18b50nc5","dangerouslySetInnerHTML":{"__html":"$76"}}]}]],"$L77"]}] 78:T621,
=== Phase 1: Setting up 'Platform Engineering' ===
Created department 'Platform Engineering' with ID: 9b3f7a2c-1d4e-4f5b-8a6c-7d8e9f0a1b2c
Assigned Alice Johnson to 'Platform Engineering'
Promoted Alice Johnson to Head of Department
Assigned Bob Smith as manager to Alice Johnson
- Invited dana.white@example.com
- Invited edward.black@example.com
- Invited fiona.green@example.com
Invited 3 team members to 'Platform Engineering'
Unsuspended Carol White
Backfilled role 'Member' with Carol White (replacement for Alice Johnson)

=== Phase 2: Closing 'Public Relations' ===
Suspended Dave Brown
Suspended Eve Green
Removed Dave Brown
Removed Eve Green
Deleted department 'Public Relations'
6f:["$","div",null,{"className":"wzy01m0 _18b50nc0","children":[["$undefined",["$","$L74",null,{"className":"_18b50nc3","defaultWrap":false,"children":["$","div",null,{"className":"_18b50nc4","dangerouslySetInnerHTML":{"__html":"$78"}}]}]],["$","div",null,{"className":"wzy01m1","children":["$","$L75",null,{"code":"=== Phase 1: Setting up 'Platform Engineering' ===\nCreated department 'Platform Engineering' with ID: 9b3f7a2c-1d4e-4f5b-8a6c-7d8e9f0a1b2c\nAssigned Alice Johnson to 'Platform Engineering'\nPromoted Alice Johnson to Head of Department\nAssigned Bob Smith as manager to Alice Johnson\n- Invited dana.white@example.com\n- Invited edward.black@example.com\n- Invited fiona.green@example.com\nInvited 3 team members to 'Platform Engineering'\nUnsuspended Carol White\nBackfilled role 'Member' with Carol White (replacement for Alice Johnson)\n\n=== Phase 2: Closing 'Public Relations' ===\nSuspended Dave Brown\nSuspended Eve Green\nRemoved Dave Brown\nRemoved Eve Green\nDeleted department 'Public Relations'\n"}]}]]}] 79:T13a5,import requests # ============================================= # Configuration # ============================================= API_URL = "https://sandbox-b2b.revolut.com/api/1.0" API_TOKEN = "YOUR_ACCESS_TOKEN" HEADERS = {"Authorization": f"Bearer {API_TOKEN}", "Content-Type": "application/json"} # Existing team member being promoted to head the new department PROMOTED_MEMBER_ID = "11111111-1111-1111-1111-111111111111" # Their new manager (another existing team member) NEW_MANAGER_ID = "22222222-2222-2222-2222-222222222222" # New hire who will backfill the promoted member's previous role BACKFILL_MEMBER_ID = "33333333-3333-3333-3333-333333333333" # Department being closed CLOSING_DEPT_ID = "cccccccc-cccc-cccc-cccc-cccccccccccc" # Emails of new hires joining the new department NEW_TEAM_EMAILS = [ "dana.white@example.com", "edward.black@example.com", "fiona.green@example.com", ] NEW_MEMBER_ROLE_ID = "member" # Retrieve available roles with GET /roles HEAD_ROLE_ID = "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb" NEW_DEPT_NAME = "Platform Engineering" def api(method, path, body=None): """Make an API request and return the JSON response (or None for 204).""" resp = requests.request(method, f"{API_URL}{path}", headers=HEADERS, json=body) if not resp.ok: print(f"ERROR {resp.status_code} {method} {path}: {resp.text}") resp.raise_for_status() return resp.json() if resp.content else None def fmt_name(m): """Return 'First Last' or fall back to email if names are null.""" name = f"{m.get('first_name') or ''} {m.get('last_name') or ''}".strip() return name or m["email"] # Build a lookup of role IDs to names roles = api("GET", "/roles?limit=1000") role_names = {r["id"]: r["name"] for r in roles} # ============================================= # Phase 1: New department and team growth # ============================================= print(f"=== Phase 1: Setting up {NEW_DEPT_NAME} ===") # 1. Create the new department dept = api("POST", "/departments", {"name": NEW_DEPT_NAME}) dept_id = dept["id"] print(f"Created department '{NEW_DEPT_NAME}' with ID: {dept_id}") # 2. Assign an existing team member to the new department, then promote them to head it # Save their current role and department so we can backfill later. promoted = api("GET", f"/team-members/{PROMOTED_MEMBER_ID}") previous_role_id = promoted.get("role_id") previous_dept_id = promoted.get("department_id") api("PUT", f"/team-members/{PROMOTED_MEMBER_ID}/department", {"department_id": dept_id}) print(f"Assigned {fmt_name(promoted)} to '{NEW_DEPT_NAME}'") api("PUT", f"/team-members/{PROMOTED_MEMBER_ID}/role", {"role_id": HEAD_ROLE_ID}) print(f"Promoted {fmt_name(promoted)} to {role_names[HEAD_ROLE_ID]}") manager = api("GET", f"/team-members/{NEW_MANAGER_ID}") api("PUT", f"/team-members/{PROMOTED_MEMBER_ID}/manager", {"manager_id": NEW_MANAGER_ID}) print(f"Assigned {fmt_name(manager)} as manager to {fmt_name(promoted)}") # 3. Invite new hires and assign them to the department for email in NEW_TEAM_EMAILS: member = api("POST", "/team-members", {"email": email, "role_id": NEW_MEMBER_ROLE_ID}) api("PUT", f"/team-members/{member['id']}/department", {"department_id": dept_id}) api("PUT", f"/team-members/{member['id']}/manager", {"manager_id": PROMOTED_MEMBER_ID}) print(f"- Invited {email}") print(f"Invited {len(NEW_TEAM_EMAILS)} team members to '{NEW_DEPT_NAME}'") # 4. Backfill the promoted member's previous role # Unsuspend the backfill member (they were invited but hadn't started yet) backfill = api("GET", f"/team-members/{BACKFILL_MEMBER_ID}") api("POST", f"/team-members/{BACKFILL_MEMBER_ID}/unsuspend") print(f"Unsuspended {fmt_name(backfill)}") api("PUT", f"/team-members/{BACKFILL_MEMBER_ID}/role", {"role_id": previous_role_id}) if previous_dept_id: api("PUT", f"/team-members/{BACKFILL_MEMBER_ID}/department", {"department_id": previous_dept_id}) print(f"Backfilled role '{role_names[previous_role_id]}' with {fmt_name(backfill)} (replacement for {fmt_name(promoted)})") # ============================================= # Phase 2: Department closure # ============================================= closing = api("GET", f"/departments/{CLOSING_DEPT_ID}") print(f"\n=== Phase 2: Closing '{closing['name']}' ===") # 5. Suspend all team members in the closing department members = api("GET", "/team-members?limit=1000") closing_members = [m for m in members if m.get("department_id") == CLOSING_DEPT_ID] for m in closing_members: api("POST", f"/team-members/{m['id']}/suspend") print(f"Suspended {fmt_name(m)}") # 6. Remove suspended members from the department and delete them for m in closing_members: api("DELETE", f"/team-members/{m['id']}/department") api("DELETE", f"/team-members/{m['id']}/manager") api("DELETE", f"/team-members/{m['id']}") print(f"Removed {fmt_name(m)}") # 7. Delete the department api("DELETE", f"/departments/{CLOSING_DEPT_ID}") print(f"Deleted department '{closing['name']}'") 77:["$","div",null,{"className":"wzy01m1","children":["$","$L75",null,{"code":"$79"}]}]