Pay for an order
Pays for a specific order with a payment source. Important: Either a payment source or customer must be associated with an order for payment. If a customer is not attached to the order, then the source in this field is charged for the order.
Path parameters
Universally unique identifier (UUID) of the order.
Headers
Identifies the application, operating system, vendor, and/or version of the requesting user agent. Format: <AppName>/<Version> <Comment>
Client internet protocol (IP) address of the web browser from which the customer’s payment originates. Note: Header x-forwarded-for is required for enhanced security and accuracy of Clover services. Requests that don’t include the header are not successful.
Request body
Universally unique identifier (UUID) of the customer being charged for the order. The customer indicated here is charged instead of the customer associated with the order creation. See Create a customer. Important: Either a payment source or customer must be associated with an order for payment. If a customer is not attached to the order, then the source in this field is charged for the order.
Indicates who entered the card data used for a charge - customer (ecom) or merchant (moto).
Email address of the customer placing the order. Required if the email address is not provided when creating the order.
Charge amount. If the charge request includes tax (tax_rate_uuid or tax_amount), this value must be the sum of any item prices and any tax or tip. For example: If the item cost = $10 and the tax is $1, the amount is 1100 cents ($11). Format: Cents
Three-letter ISO 4217 currency code. Format: Lower case Length: Maximum 3
Indicates whether the charge can be authorized for a lesser amount. Values: True False - Default
Additional information provided as an expanded response, for example, related objects nested within the parent. See Use expandable fields.
Unique identifier (ID), such as an invoice or purchase order (PO) number, that is sent to the merchant's gateway and displayed in settlement records. Format: Supported for US—alphanumeric characters with in-between spaces. Length: Maximum 12, including spaces and alphanumeric characters.
Customer reference number from the merchant's order management system.
Set of key-value pairs that you can attach to the object. This parameter is useful for storing additional information about the object in a structured format. Length: Maximum 500 characters
Payment source to charge, such as token or alternate_tender. See Create a card token. or Create an ACH token. Important: Either a payment source or customer must be associated with an order for payment. If a customer is not attached to the order, then the source in this field is charged for the order.
Intent of the external token. Note: For a new TransArmor<sup>®</sup> token, select save_credential_on_file.
Amount paid in tips. This value is automatically added to the total amount when the transaction is finalized.
Response
Successful response. Order payment successfully processed.
Total order amount in the smallest monetary unit of the merchant's currency.
Amount currently paid toward the order total.
Amount still due toward the order total.
Merchant-defined flat tax amount for the order. Format: Cents
Amount currently paid toward the tax total.
Amount paid in tips. This value is automatically added to the total amount when the transaction is finalized.
Indicates if partial approval has occurred.
Charge identifier. Returns the result when the order status is paid, fulfilled, or refunded.
Authorization code of the charge, if available.
External coupon code available for this order.
Billing address country, if provided.
Time stamps when the order was last updated.
First 6 numbers of the primary account number.
Displays the pre-authorized amount for the order. If any.
If available, the reference number returned from the payment gateway if the transaction is successful.
Detailed warning information about the order or associated charge (for example, missing original transaction id for c-token).
Indicates who entered the card data used for a charge - customer (ecom) or merchant (moto).
Displays results based on the object's created field. Values: String with a Unix timestamp (in milliseconds) or Dictionary of multiple options describing a time range.
Three-letter ISO 4217 currency code.
Customer identifier.
Email address of the customer placing the order.
An identifier such as an invoice or PO number, passed to the merchant's gateway and ultimately appears in settlement records. Note: Applicable for US customers, spaces are allowed in the reference number. Length: Max 12 (including alphanumeric characters)
Customer reference number from the merchant's order management system.
Order identifier.
Indicates whether the item is in production or sandbox. True - Item is in production False - Item is in sandbox
Set of key-value pairs that you can attach to the object. This parameter is useful for storing additional information about the object in a structured format. Length: Maximum 500 characters
Object type. Objects with the same type have the same value.
Selected shipping method of the order. If present, the value is set from the shipping_methods list. For multiple shipping methods, the first method is automatically selected.
Current order status.