Commerce Webstore Checkout Payments

Payment for a Commerce store checkout.

Resource

1/commerce/webstores/webstoreId/checkouts/activeOrCheckoutId/payments

Values for activeOrCheckoutId are:

checkoutId—ID of the checkout.
active—Active checkout.

Available version

55.0

Requires Chatter

HTTP methods

POST

Request body for POST

Root XML tag

<checkoutPaymentInput>

JSON example for authorized payment

1{
2   "paymentToken":"AF045455-69B0-46EF-90FC-9E1DE279657F",
3   "requestType":"Auth",
4   "billingAddress":{
5      "name":"John Doe",
6      "street":"123 Acme Drive",
7      "city":"Los Angeles",
8      "region":"California",
9      "regionCode":"CA",
10      "country":"United States",
11      "countryCode":"US",
12      "postalCode":"90001"
13   }
14}

JSON example for client request

1{
2   "requestType":"ClientRequest",
3   "paymentsData":{
4      "origin":"100.10.11.24"
5   }
6}

Properties

Name	Type	Description	Required or Optional	Available Version
`billingAddress`	Checkout Address Input	Billing address for the checkout.	Optional	55.0
`paymentToken`	String	Payment token for the checkout. This property is required when `requestType` is `Auth`.	Optional	55.0
`paymentsData`	String	Payments data for a custom checkout. Use this property to pass custom data (as valid JSON). This property is required when `requestType` is `ClientRequest`.	Optional	55.0
`requestType`	String	Type of payment request. Valid values are: `Auth`—Payment authorization request. `ClientRequest`—Custom client payment request.	Required	55.0

Response body for POST

Checkout Payment

Connect REST API Developer Guide

Commerce Webstore Checkout Payments