v1

latestOpenAPI 3.0.12026-07-26381328555.2 KB

Checkout

Perform Payment Action

Sets the action of the specified payment transaction interaction. Available actions depend on the current status of the payment transaction. \r\nIf in doubt, get a list of available <a href="/pages/payment-states#payment-actions">payment actions</a> first. Note that for order management-only systems that use No-Operation payment gateways, such as due to the payments being processed by an external storefront or service instead of UCP, these actions will not actually be performed by UCP and instead will be automatically marked as a success.

post/commerce/checkouts/{checkoutId}/payments/{paymentId}/actions

Path parameters

checkoutIdstring required

Unique identifier of the checkout whose payment action you want to change.

paymentIdstring required

Query parameters

responseFieldsstring

limits which fields are returned in the response body

Request body

actionNamestring nullable

Name of the Action to post

amountnumber double nullable

Amount of funds to withdraw to pay for this order.

cancelUrlstring nullable

If paying by Paypal Express or some other potential non-gateway payment provider, a cancel redirect URL must be provided. This will be used if something goes wrong on the third-party side.

checkNumberstring nullable

If paying by check, the check number.

currencyCodestring nullable

ISO currency code for the transaction. Currently, only USD is supported.

dataobject nullable

Custom data from payment providers

externalTransactionIdstring nullable

installmentPlanCodestring nullable

Stores the Installment Plan code. Installment is only supported on subscription orders

interactionDatestring date-time nullable

Date the interaction occurred

recaptchastring nullable

Recaptcha for validation.

referenceSourcePaymentIdstring nullable

Reference payment id from which to copy the billing info.

returnUrlstring nullable

If paying by Paypal Express or some other potential non-gateway payment provider, a return redirect URL must be provided.

Response

acceptsMarketingboolean nullable

Does the customer accept marketing

amountRemainingForPaymentnumber double

A counter for how much of the total has not been claimed by payments. This is computed by Total - (sum of Payments where State is not Voided/Declined)

availableActionsstring[] nullable

channelCodestring nullable

Unique identifier of the channel for this item.

couponCodesstring[] nullable

Coupon codes associated with this order.

currencyCodestring nullable

ISO Currency Code.

customerAccountIdinteger nullable

Unique identifier of the customer account.

customerInteractionTypestring nullable

Determines the interaction type that a customer will use to create this object. Valid values are: Website, Store, Call, Unknown

customerTaxIdstring nullable

The customers tax ID. If Customer Account ID exists in the system, will set this.

dataobject nullable

Custom data for a given vendor set within the commerce process.

dutyTotalnumber double nullable

Total duty fees

emailstring nullable

Email address for checkout

feeTotalnumber double

Total Fees

handlingSubTotalnumber double

Pre-Discounted Handling Subtotal of the CommerceAggregate and its Items. Returns null if the calculated value is negative.

handlingTaxTotalnumber double

Total tax on handling.

handlingTotalnumber double

Overall handling total, accounting for line and order-level handling costs, any handling discounts, and handling tax.

idstring nullable

Unique identifier.

ipAddressstring nullable

IP address of the user placing the order. (User or customer?)

isTaxExemptboolean nullable

Unique identifier of the customer account.

itemLevelHandlingDiscountTotalnumber double

The total value of item-level handling discounts.

itemLevelProductDiscountTotalnumber double

The total value of item-level product discounts.

itemLevelShippingDiscountTotalnumber double

The total value of item-level shipping discounts.

itemTaxTotalnumber double

Total tax on products.

itemTotalnumber double

The total product cost, accounting for discounts and tax.

locationCodestring nullable

Identifies the location at which the order was placed if the order was placed externally.

numberinteger nullable

A checkout number that is only assigned after the checkout is placed.

orderLevelHandlingDiscountTotalnumber double

The total value of order-level (group-level) handling discounts.

orderLevelProductDiscountTotalnumber double

The total value of order-level (group-level) product discounts.

orderLevelShippingDiscountTotalnumber double

The total value of order-level (group-level) shipping discounts.

originalCartIdstring nullable

Unique identifier for the cart that was converted to checkout.

priceListCodestring nullable

Pricelist code for the checkout

shippingSubTotalnumber double

Shipping does not appear on cart.

shippingTaxTotalnumber double

Total tax on shipping.

shippingTotalnumber double

Overall shipping total, accounting for item and order-level shipping costs, any shipping discounts, and shipping tax.

siteIdinteger

Unique identifier of the Site.

sourceDevicestring nullable

Source device of the user placing the order. (User or customer?)

subTotalnumber double

Subtotal before any coupon codes, taxes, fees, etc.

submittedDatestring date-time nullable

When the customer placed (submitted) the order.

taxDataobject nullable

Storage for any additional/custom tax data.

tenantIdinteger

Unique identifier of the Tenant.

totalnumber double

Final total

typestring nullable

Is this Order Online or Offline? Online means shopper entered at checkout, offline means a phone order.

visitIdstring nullable

Identifies the Visit ID that was current when the order was placed or when the cart was last updated.

webSessionIdstring nullable

Identifies the web session used to place the order or last update the cart.