Get Payment Methods For Basket

Retrieve payment instruments for a basket.

GET/organizations/{organizationId}/baskets/{basketId}/payment-methods

Use it in a workflow

Add a step and choose the Salesforce Commerce Cloud connector.
Pick the Get Payment Methods For Basket action (under Shopper Baskets v1).
Fill in the fields below, then reference the result from later steps as {{getPaymentMethodsForBasket.response.data}}.

Request

Path parameters

organizationIdstringrequired

An identifier for the organization the request is being made by

basketIdstringrequired

The ID of the basket to be modified.

Query parameters

siteIdstringrequired

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.

localeoneOf

A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.

Response

Returns 200 with an object. Read it in later steps with {{getPaymentMethodsForBasket.response.data.<field>}}.

applicablePaymentMethodsarray<object>

The applicable payment methods. It is read only.

cardsarray<object>8 fields

The sorted array of payment cards (included only when the system payment method is CREDIT_CARD). It is read only.

descriptionstring

The localized description of the payment method or card. It is read only.

idstringrequired

The ID of the payment method or card. It is read only.

imagestring

The URL to the image that represents the payment method or card. It is read only.

namestring

The localized name of the payment method or card. It is read only.

paymentProcessorIdstring

The payment processor ID. It is read only. It is read only.

json

{
  "applicablePaymentMethods": [
    {
      "id": "string",
      "cards": [
        {
          "cardType": "Visa",
          "checksumVerificationEnabled": true,
          "description": "string",
          "image": "string",
          "name": "string",
          "numberLengths": [
            "string"
          ],
          "numberPrefixes": [
            "string"
          ],
          "securityCodeLength": 0
        }
      ],
      "description": "string",
      "image": "string",
      "name": "string",
      "paymentProcessorId": "string"
    }
  ]
}

Need more? See the Salesforce Commerce Cloud guide for connection setup and behaviour shared by every action.

Was this page helpful?