j1.6.0
API Overview
Use the Shopper Payments API to:
- Retrieve payment configuration information for storefronts when Salesforce Payments is enabled.
The API returns the available payment methods, merchant account details, and payment gateway configurations for a specific payment zone site assignment.
The response includes:
- Zone ID: The unique identifier for the Payments zone.
- Payment Method Set Accounts: List of configured payment processor accounts with API keys, vendor information (Stripe, Adyen, PayPal, etc.), and live/test mode indicators.
- Payment Methods: List of available payment methods with their associated accounts, payment method types, and supported payment modes.
Authentication & Authorization
The client requesting payment configuration must have access to the /payment-configuration resource. The Shopper Payments API requires a shopper access token from the Shopper Login and API Access Service (SLAS).
For details on how to request a shopper access token from SLAS, see the guest user flows for public clients and private clients in the SLAS guides.
You must include sfcc.shopper-baskets-orders, sfcc.shopper-baskets-orders.rw, or sfcc.shopper-standard in the client ID used to generate the SLAS token. For a full list of permissions, see the Authorization Scopes Catalog.
Response Details
Personalization
Responses from this API are not personalized via the Shopper Context API.
Caching
Responses from this API are not cached.
Timeouts
Shopper API requests must respond within 10 seconds, including any hook execution. If a response exceeds this threshold, an HTTP 504 status code is returned. For details, see Timeouts and Limits.
Error Handling
Error responses follow the RFC 7807 problem detail format. To trace errors, include a correlation-id header in your request — the response returns it as x-correlation-id. For details, see HTTP Status Codes and Errors.
Use Cases
Get Payment Configuration
Retrieve the available payment methods for a site.
curl "https://{shortCode}.api.commercecloud.salesforce.com/checkout/shopper-payments/v1/organizations/{organizationId}/payment-configuration?siteId=RefArch" \
-H "Authorization: Bearer {access_token}"
Retrieve Payment Configuration
Retrieve payment configuration settings for Stripe, PayPal, and Adyen based on the payment methods enabled in the merchant's payment zone site. This includes API keys, vendor details, and live/test mode status. Specify a zone via zoneId or use currency and countryCode for automatic resolution.
Related APIs
- Shopper Baskets — Build baskets and add payment instruments.
Let us know so we can improve!