v1
latestOpenAPI 3.0.12026-07-26381328555.2 KBCreate Payment Action
Sets the action of the specified payment transaction interaction. Available actions depend on the current status of the payment transaction. If in doubt, get a list of available <a href="/pages/payment-states#payment-actions">payment actions</a> first.
Path parameters
Unique identifier of the checkout whose payment action you want to change.
Query parameters
limits which fields are returned in the response body
Request body
Name of the Action to post
Amount of funds to withdraw to pay for this order.
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.
If paying by check, the check number.
ISO currency code for the transaction. Currently, only USD is supported.
Custom data from payment providers
Stores the Installment Plan code. Installment is only supported on subscription orders
Date the interaction occurred
Recaptcha for validation.
Reference payment id from which to copy the billing info.
If paying by Paypal Express or some other potential non-gateway payment provider, a return redirect URL must be provided.
Response
OK
Does the customer accept marketing
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)
Unique identifier of the channel for this item.
Coupon codes associated with this order.
ISO Currency Code.
Unique identifier of the customer account.
Determines the interaction type that a customer will use to create this object. Valid values are: Website, Store, Call, Unknown
The customers tax ID. If Customer Account ID exists in the system, will set this.
Custom data for a given vendor set within the commerce process.
Total duty fees
Email address for checkout
Total Fees
Pre-Discounted Handling Subtotal of the CommerceAggregate and its Items. Returns null if the calculated value is negative.
Total tax on handling.
Overall handling total, accounting for line and order-level handling costs, any handling discounts, and handling tax.
Unique identifier.
IP address of the user placing the order. (User or customer?)
Unique identifier of the customer account.
The total value of item-level handling discounts.
The total value of item-level product discounts.
The total value of item-level shipping discounts.
Total tax on products.
The total product cost, accounting for discounts and tax.
Identifies the location at which the order was placed if the order was placed externally.
A checkout number that is only assigned after the checkout is placed.
The total value of order-level (group-level) handling discounts.
The total value of order-level (group-level) product discounts.
The total value of order-level (group-level) shipping discounts.
Unique identifier for the cart that was converted to checkout.
Pricelist code for the checkout
Shipping does not appear on cart.
Total tax on shipping.
Overall shipping total, accounting for item and order-level shipping costs, any shipping discounts, and shipping tax.
Unique identifier of the Site.
Source device of the user placing the order. (User or customer?)
Subtotal before any coupon codes, taxes, fees, etc.
When the customer placed (submitted) the order.
Storage for any additional/custom tax data.
Unique identifier of the Tenant.
Final total
Is this Order Online or Offline? Online means shopper entered at checkout, offline means a phone order.
Identifies the Visit ID that was current when the order was placed or when the cart was last updated.
Identifies the web session used to place the order or last update the cart.