Your app must request specific permissions from merchants to access and update their data. In addition, on the Developer Dashboard, you must specify the Ecommerce integration type you are using for your app.

Required app permissions

Merchants using your app grant your app permissions during installation, and your app will use the associated OAuth token to use for all API calls on behalf of the merchant (see Using OAuth 2.0 for more information about the OAuth flow). Your app should only request the minimum permissions required for your app to function.

PAKMS service endpoint

Tokenization service endpoint

🚧

IMPORTANT

To create a token using POST /v1/tokens, you need a public key retrieved from the PAKMS service.

Ecommerce service endpoints

Charge endpoints

Customer endpoints

Order endpoints

📘

NOTE

Getting an order with GET /v1/orders/{orderId} auto-expands the following fields:

• lineItems
• lineItems.taxRates
• payments
• refunds
• customers

Refund endpoints

Setting app permissions and integration type

To set app permissions and integration type for your app:

1. On the Developer Dashboard, click App Settings on the side-nav.
2. On the App Settings page, click Requested Permissions.
3. On the Edit Requested Permissions modal that appears, select your app's read or write permissions for Ecommerce API as required. For any selected permission, provide in-line justification about how your app is using this information.
4. Click Save. Your selected permissions appear on the App Settings page.
5. On the App Settings page, click the additional Ecommerce Settings that appear.
6. On the Edit Ecommerce Settings modal that appears, select your integration type. See Integration types for more information.
7. Click Save. Your selected integration type appears on the App Settings page.