Which API key scopes do I need to configure my Shopify store to use the Payments API?

Depending on the Shopify app you use, you may need different permissions:

• Shopify onsite – Ensure you configure the following scopes:

  • disputes:accept

  • disputes:provide-evidence

  • disputes:view

  • files

  • flow:events

  • flow:workflows

  • gateway

  • gateway:payment

  • gateway:payment-authorizations

  • gateway:payment-captures

  • gateway:payment-details

  • gateway:payment-refunds

  • gateway:payment-voids

  • middleware

  • middleware:merchants-secret

  • payment-sessions

  • vault:instruments

  • sessions:browser

• Shopify offsite – Because this integration uses a Hosted Payments Page, ensure you configure the same scopes required for this feature:

  • accounts

  • balances

  • balances:view

  • card-management

  • disputes

  • disputes:accept

  • disputes:provide-evidence

  • disputes:view

  • files

  • files:download

  • files:retrieve

  • files:upload

  • financial-actions

  • financial-actions:view

  • flow

  • flow:events

  • flow:workflows

  • fx

  • gateway

  • gateway:payment

  • gateway:payment-authorizations

  • gateway:payment-captures

  • gateway:payment-details

  • gateway:payment-refunds

  • gateway:payment-voids

  • identity-verification

  • issuing-disputes

  • issuing:card-management-read

  • issuing:card-management-writeoperations

  • issuing:controls-read

  • issuing:controls-write

  • issuing:disputes-read

  • issuing:disputes-write

  • issuing:transactions-read

  • issuing:transactions-write

  • middleware

  • middleware:merchants-publicexecution environment

  • middleware:merchants-secretexecution environment

  • payment-sessions

  • payouts:bank-details

  • reports

  • reports:view

  • sessions:app

  • sessions:browser

  • transactions

  • transfers

  • transfers:create

  • transfers:view

  • vault

  • vault:instruments

  • vault:tokenization