Shopper Payments

GET Get payment configuration

GET /organizations/{organizationId}/payment-configuration

Operation ID: getPaymentConfiguration. Security: ShopperToken (sfcc.shopper-baskets-orders, sfcc.shopper-baskets-orders.rw, sfcc.shopper-standard); ShopperClientContextToken (sfcc.shopper-baskets-orders, sfcc.shopper-baskets-orders.rw, sfcc.shopper-standard).

Retrieves the payment configuration for the organization.

Parameters:

• siteId: Required. The site identifier for context-specific configuration
• currency: Required. Three-letter currency code (ISO 4217) for payment method configuration
• countryCode: Optional. Two-letter country code (ISO 3166-1 alpha-2) for country-specific payment configuration
• amount: Optional. Transaction amount for payment method configuration
• zoneId: Optional. Payment zone identifier to retrieve zone-specific configuration

Response Behavior:

• Returns payment configuration data when available
• Returns null values for missing data (e.g., when account not found or payments zone not found)

Parameters

• organizationId (path, OrganizationId, required) An identifier for the Salesforce Commerce Cloud organization the request is being made by. It consists of a prefix 'f_ecom_' followed by a 4-character realm identifier and a 3-character instance type identifier.

  Example

  f_ecom_zzxy_prd

• siteId (query, SiteId, required) The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.

  Example: SiteId

  RefArch

• currency (query, CurrencyCode, required) A three letter uppercase currency code conforming to the ISO 4217 standard, or the string N/A indicating that a currency is not applicable.

  Example: CurrencyCode

  USD

• countryCode (query, CountryCode) The country code (ISO 3166-1 alpha-2) for country-specific payment configuration filtering.
• zoneId (query, ZoneId) The zone identifier for the payment configuration. Optional, if specified will return zone specific payment configuration instead of resolving based on the currency and country.

  Example: ZoneId

  Amer-Zone

• amount (query, Amount) The transaction amount. Optional. Some gateways, such as Adyen, allow for payment methods to be qualified or disqualified based on the amount of the transaction.
• sfdc_usid (header, string (uuid)) A unique shopper identifier (USID) for tracking client context. Used with endpoints secured with ShopperClientContextToken. This header is required for all endpoints secured with ShopperClientContextToken.
  Example: 550e8400-e29b-41d4-a716-446655440000.
• personalized (query, string) Controls whether personalization is applied to the response. When set to none, the server skips applying personalization to the response.
  Allowed values: none. Example: none.
• sfdc_shopper_context (header, string) Shopper context information (for example clientIP, sourceCode, and customQualifiers) passed in from a trusted backend application.

Responses

• 200 Payment configuration details.

  Media type: application/json. Schema: PaymentConfiguration.

  Example: stripeConfiguration

  {
    "zoneId": "Amer-Zone",
    "paymentMethodSetAccounts": [
      {
        "accountId": "acct_1RegszI5I22eU0I3",
        "config": {
          "key": "pk_test_JsbBx7imKb7n7Xtlb5MH5BNO00ttiURmPV"
        },
        "live": false,
        "vendor": "Stripe"
      }
    ],
    "paymentMethods": [
      {
        "accountId": "acct_1RegszI5I22eU0I3",
        "paymentMethodType": "card",
        "paymentModes": [
          "Multistep"
        ]
      }
    ]
  }

  Example: stripeAndPaypalConfiguration

  {
    "zoneId": "Amer-Zone",
    "paymentMethodSetAccounts": [
      {
        "accountId": "acct_1RegszI5I22eU0I3",
        "config": {
          "key": "pk_test_JsbBx7imKb7n7Xtlb5MH5BNO00ttiURmPV"
        },
        "live": false,
        "vendor": "Stripe"
      },
      {
        "accountId": "XK92PMVFNRBDG",
        "config": {
          "bnCode": "SalesforceCommerceCloud_PPCP",
          "key": "AYzMrnD7y4Zc5m5QJZTQ4zPKbP8TMn0r7aStK_3hM9gnaykL-VwK5tGQj4g1y93V6UNvC5j_FZSSa6xpR"
        },
        "live": false,
        "vendor": "Paypal"
      }
    ],
    "paymentMethods": [
      {
        "accountId": "acct_1RegszI5I22eU0I3",
        "paymentMethodType": "card",
        "paymentModes": [
          "Multistep"
        ]
      },
      {
        "accountId": "XK92PMVFNRBDG",
        "paymentMethodType": "paypal",
        "paymentModes": [
          "Multistep"
        ]
      }
    ]
  }

  Example: adyenConfiguration

  {
    "zoneId": "Amer-Zone",
    "paymentMethodSetAccounts": [
      {
        "accountId": "TestAccount941ECOM",
        "config": {
          "country": "US",
          "key": "test_JE2ML2CMKZHJRL3QWUW4YCE32A3SL3BH",
          "paymentMethods": {
            "paymentMethods": [
              {
                "brands": [
                  "amex",
                  "cup",
                  "diners",
                  "discover",
                  "mc",
                  "visa"
                ],
                "name": "Cards",
                "type": "scheme"
              }
            ]
          }
        },
        "live": false,
        "vendor": "Adyen"
      }
    ],
    "paymentMethods": [
      {
        "accountId": "TestAccount941ECOM",
        "paymentMethodType": "card",
        "paymentModes": [
          "Multistep"
        ]
      }
    ]
  }

  Example: noDataFound

  {
    "zoneId": null,
    "paymentMethodSetAccounts": [],
    "paymentMethods": []
  }

• 400

  Possible reasons:

  • the site ID is required and must not be null.
  • the specified currency is invalid (must be ISO 4217) or not supported by the site.
  • the provided country code is invalid (must be 2 uppercase letters matching ISO 3166-1 alpha-2).
  • the provided zone ID is invalid (must match pattern [a-zA-Z0-9-_]{1,100}).
  • the provided amount is invalid (must be non-negative).

  Media type: application/problem+json. Schema: ErrorResponse.

  Example: BadRequest

  {
    "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/bad-request",
    "title": "Bad Request",
    "detail": "Decoding of the property with path '$.failedExample.[1].intProperty' failed because the expected type is 'Integer|Decimal' but the actual type was 'String'."
  }

  Example: InvalidPaymentConfigurationRequest

  {
    "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/invalid-payment-configuration-request",
    "title": "Bad Request",
    "detail": "The payment configuration request field 'countryCode' is invalid.",
    "invalidField": "countryCode"
  }