---
title: Authorization scopes
description: Learn what the allowed scopes are when interacting with Shop Pay's Wallet API.
api_name: shop-pay-wallet
source_url:
  html: https://shopify.dev/docs/api/shop-pay-wallet/scopes
  md: https://shopify.dev/docs/api/shop-pay-wallet/scopes.md
---

ExpandOn this page

* [Examples](https://shopify.dev/docs/api/shop-pay-wallet/scopes#examples)
* [Related resources](https://shopify.dev/docs/api/shop-pay-wallet/scopes#related-resources)

# Authorization scopes

The Shop Pay Wallet API provides a user's data for developers to make a payment on their behalf. The data is split into separate resources each requiring their own scope. To [request buyer authorization](https://shopify.dev/docs/api/shop-pay-wallet/reference/index#authorizations) to access their Shop Pay Wallet you must, therefore, include a combination of the following scopes as a space-delimited string in the request.

| | | | |
| - | - | - | - |
| **Scope** | **Resource** | **PCI Compliance Required?** | **Details** |
| `uma:pay:address:read` | Address | No | Use this scope to request access to the buyer's shipping address. |
| `uma:pay:credit_card:read` | Credit Card | No | Use this scope to request access to the buyer's credit card summary. |
| `uma:pay:credit_card:read_payment_session` | Payment Token | No | Use this scope to request access to a [Payment Session ID](https://shopify.dev/docs/api/admin-rest/latest/resources/payment.html). This scope is required when completing checkouts with Shopify Merchants. |
| `uma:pay:credit_card:read_encrypted` | Encrypted PAN | Yes | Use this scope to request access to the encrypted [Primary Account Number (PAN)](https://en.wikipedia.org/wiki/Payment_card_number) of the buyer's credit card. This scope is required when completing checkouts with non-Shopify merchants. |

***

## Examples

### Non-PCI compliant partners

The scope string you should provide to [request user authorization](https://shopify.dev/docs/api/shop-pay-wallet/reference/index#authorizations) is:

```text
scope=uma:pay:address:read uma:pay:credit_card:read uma:pay:credit_card:read_payment_session
```

### PCI compliant partners working with Shopify and non-Shopify merchants

The scope string you should provide to [request user authorization](https://shopify.dev/docs/api/shop-pay-wallet/reference/index#authorizations) is:

```text
scope=uma:pay:address:read uma:pay:credit_card:read uma:pay:credit_card:read_payment_session uma:pay:credit_card:read_encrypted
```

***

## Related resources

* [Getting Started with the Shop Pay Wallet API](https://shopify.dev/docs/api/shop-pay-wallet/getting-started)
* [Authorization](https://shopify.dev/docs/api/shop-pay-wallet/authorization)
* [Shop Pay Wallet API reference](https://shopify.dev/docs/api/shop-pay-wallet/reference/index)
* [Testing the integration](https://shopify.dev/docs/api/shop-pay-wallet/testing)
* [Shop Pay Wallet ecosystem](https://shopify.dev/docs/api/shop-pay-wallet/ecosystem)

***

* [Examples](https://shopify.dev/docs/api/shop-pay-wallet/scopes#examples)
* [Related resources](https://shopify.dev/docs/api/shop-pay-wallet/scopes#related-resources)