Authorization scopes

To request authorization on behalf of a buyer to access their Shop Pay Wallet, you must include a combination of the following scopes as a space-delimited string in the request:

  • uma:pay:address:read. Use this scope to request access to the buyer's shipping address.
  • uma:pay:credit_card:read. Use this scope to request access to the last four digits, the type, and the billing address of the buyer's credit card.
  • uma:pay:credit_card:read_encrypted. Use this scope to request access to the encrypted Primary Account Number (PAN) of the buyer's credit card.
  • uma:pay:credit_card:read_payment_session. Use this scope to request access to a Payment Session ID.

The uma:pay:credit_card:read_payment_session scope is required when using the Shop Pay Wallet API for Shopify merchant checkouts.

The uma:pay:credit_card:read_encrypted scope is only available to PCI-compliant partners for non-Shopify merchant checkouts.