Setup Customer Payment Method Reference

POST/organizations/{organizationId}/customers/{customerId}/payment-method-references/actions/setup

Use it in a workflow

Add a step and choose the Salesforce Commerce Cloud connector.
Pick the Setup Customer Payment Method Reference action (under Shopper Customers).
Fill in the fields below, then reference the result from later steps as {{setupCustomerPaymentMethodReference.response.data}}.

Request

Path parameters

customerIdstringrequired

The customer ID.

organizationIdstringrequired

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](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#realm-id) and a 3-character [instance type identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#instance-id).

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.

zoneIdstringrequired

The zone identifier for the payment configuration.

Request body

Enter the body as JSON in the step's Body field.

paymentMethodTypestring

Payment Method Type

gatewayPropertiesobjectrequired

Properties specific to the payment gateway

stripeobject

# Stripe-specific properties.

adyenobject

# Adyen-specific properties.

json

{
  "gatewayProperties": {
    "stripe": {},
    "adyen": {}
  },
  "paymentMethodType": "card"
}

Response

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

paymentMethodReferenceSetupIdstring

The provider-specific identifier for the payment method reference setup (e.g., Stripe Setup Intent ID, Adyen pspReference).

gatewayPropertiesobject