commerce/orders/payments
Use the Payments subresource to manage payment transactions for orders. Each transaction performed for an order represents an individual payment. For example, if an order totals $75.00 but the shopper has a $50.00 gift certificate, both the gift certificate transaction and the credit card transaction for the remaining $25.00 are recorded as payments for the order.
JSON Example
Payment Properties
Property | Description |
---|---|
amountCollected |
type: decimal The total monetary amount collected in this payment transaction for the order. |
amountCredited |
type: decimal If the payment transaction is a shopper store credit, the total monetary amount credited in this payment transaction for the order. |
amountRequested |
type: decimal The total amount originally requested for this payment. |
auditInfo |
type: auditInfo Basic audit info about the object, including date, time, and user account. This data may be captured when creating, updating, and removing data. |
auditInfo |
type: string Identifier of the user that created the object. System created and read only. |
auditInfo |
type: DateTime The date and time in UTC format set when the object was created. |
auditInfo |
type: string Identifier of the user that updated the entity most recently. |
auditInfo |
type: DateTime The date and time in UTC format the object was updated most recently. |
availableActions |
type: list of string Available actions you can complete for an order. These actions may differ depending on the status of the order, such as actions required to enter a payment, return of a package, and fulfillment of a shipment. |
billingInfo |
type: billingInfo Properties for the customer's billing information associated with an order or specific payment. |
billingInfo |
type: auditInfo Basic audit info about the object, including date, time, and user account. This data may be captured when creating, updating, and removing data. |
billingInfo |
type: string Identifier of the user that created the object. System created and read only. |
billingInfo |
type: DateTime The date and time in UTC format set when the object was created. |
billingInfo |
type: string Identifier of the user that updated the entity most recently. |
billingInfo |
type: DateTime The date and time in UTC format the object was updated most recently. |
billingInfo |
type: contact The cardholder's billing contact information, including addresses. |
billingInfo |
type: address Address information to supply for a contact. |
billingInfo |
type: string Physical or mailing address line one. Usually includes the street number and street name or it could be a P.O. Box. Max length: 200. |
billingInfo |
type: string Physical or mailing address line two. Usually supplements the main street address with apartment, floor, suite, building, or unit information. Max length: 200. |
billingInfo |
type: string Physical or mailing address line three. Max length: 200. |
billingInfo |
type: string Physical or mailing address line four. Max length: 200. |
billingInfo |
type: string The type of address, which is commercial or residential. |
billingInfo |
type: string The entered city or town for the address. |
billingInfo |
type: string The 2-letter geographic code representing the country for the physical or mailing address. Currently limited to the US. |
billingInfo |
type: bool Indicates if the address has been validated. If true, the address has been verified by an address validation service. |
billingInfo |
type: string The entered zip or postal code for an address. |
billingInfo |
type: string The entered state or province for an address. |
billingInfo |
type: string The company or organization name entered for a customer account. |
billingInfo |
type: string The email address for the customer account and contact. This email may be used for login to the storefront, receiving in-stock product notifications, and subscription mailing lists. |
billingInfo |
type: string The full first name of a customer or contact name. |
billingInfo |
type: int Unique identifier of the source property, such as a catalog, discount, order, or email template. For a product field it will be the name of the field. For a category ID, must be a positive integer not greater than 2000000. By default, Kibo eCommerce auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the useProvidedId query string in the endpoint. For example, api/commerce/catalog/admin/categories/?useProvidedId=true. Then, use the id property to specify the desired category ID. For a product attribute it will be the Attribute FQN. For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, bba0a1a885e2413bb097ceacf7bac366 For email templates, the ID must be one of the following values:
|
billingInfo |
type: string The full last name or surname of a customer or contact name. |
billingInfo |
type: string Character string of the middle name or initial for the customer. |
billingInfo |
type: phone List of phone numbers associated with the customer account contact. The phone numbers include area codes. |
billingInfo |
type: string Home phone number. |
billingInfo |
type: string Mobile phone number. |
billingInfo |
type: string Work phone number. |
billingInfo |
type: paymentCard Properties of a credit card used to submit payment for an order. |
billingInfo |
type: string The bin number of a branded credit card. |
billingInfo |
type: string The masked credit card number part returned from the payment gateway. |
billingInfo |
type: short The two-digit month a credit card expires for a payment method. |
billingInfo |
type: short The four-digit year the credit card expires for a payment method. |
billingInfo |
type: bool If true, the credit card information is saved to the customer account for future use. |
billingInfo |
type: bool If true, the credit card is used for a recurring order payment. |
billingInfo |
type: string The full name printed on a credit card. The name should match what is printed on the card exactly, used in validation during a payment. |
billingInfo |
type: string The type of credit card, such as Visa or Amex. |
billingInfo |
type: string Unique identifier of the credit card from the payment service. |
billingInfo |
type: checkPayment Information about the check used in the billing information, if it exists. |
billingInfo |
type: string If applicable, the check number associated with the payment action or interaction. |
billingInfo |
type: string Indicates a custom reward type. |
billingInfo |
type: Mozu.Core.Api.Contracts.Json Custom data originated by the billing service. |
billingInfo |
type: string Holds the transaction ID for an external payment type service. |
billingInfo |
type: bool If true, the system overrides the customer's billing address information with the supplied fulfillment information. |
billingInfo |
type: string The type of payment, such as credit card, check, or PayPal Express. Additional payment types will be supported in future releases. |
billingInfo |
type: string Identifies a specific workflow the payment goes through. This is used to define a workflow for external payment services. |
billingInfo |
type: purchaseOrderPayment The purchase order payment details. |
billingInfo |
type: list of purchaseOrderCustomField Details of the custom text fields associated with the purchase order. Refer to Custom Text Fields in the Purchase Order guides topic for more information. |
billingInfo |
type: string The unique identifier of the object. |
billingInfo |
type: string Descriptive text used as a label for objects, such as field names, facets, date ranges, contact information, and package information. |
billingInfo |
type: string The value of a property, used by numerous objects within Kibo eCommerce including facets, attributes, products, localized content, metadata, capabilities (Kibo eCommerce and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type. |
billingInfo |
type: purchaseOrderPaymentTerm The details of the payment terms. The payment terms are made up of a code and a description. Refer to Payment Terms in the Purchase Order guides topic for more information. |
billingInfo |
type: string The unique identifier of the object. |
billingInfo |
type: string The localized description in text for the object, displayed per the locale code. For example, descriptions are used for product descriptions, attributes, and pre-authorization transaction types. |
billingInfo |
type: string The purchase order number. Note: Kibo eCommerce does not validate the purchase order number by default; however, you can add validation functionality using Arc.js. Refer to Validate Purchase Orders During the Checkout Process in the Arc.js Guides for more information and examples. |
billingInfo |
type: string The code that identifies the store credit to apply to the order. |
billingInfo |
type: string A payment referring to a store credit or gift card.
StoreCredit and GiftCard are internally managed by Kibo eComm. Use Custom for externally managed gift cards or reward systems. If Custom is used, provide the name for the custom type in the CustomCreditType field. |
billingInfo |
type: paymentToken The token to access billing information. |
billingInfo |
type: string The identifier of the payment service token. |
billingInfo |
type: string The type of scope, which is a developer account or production tenant. |
changeMessages |
type: list of changeMessage Collection (list or paged) of change messages logged for each modification made by a shopper to their carts, wishlists, orders, package, payment, pickup, and returns. Change log messages are system-supplied based on shopper actions and read only. |
changeMessage |
type: decimal The amount of the order-level adjustment, which can be a positive or negative amount. |
changeMessage |
type: string Unique identifier of an app available in your Kibo eCommerce tenant or within Kibo eCommerce Dev Center. This ID is unique across all apps installed, initialized, and enabled in the Admin and those in development through the Dev Center Console. |
changeMessage |
type: string The application's key. |
changeMessage |
type: string The application's name. |
changeMessage |
type: string The unique identifier of the API request associated with the event action, which might contain multiple actions. |
changeMessage |
type: DateTime The date and time in UTC format set when the object was created. |
changeMessage |
type: string Unique identifier of the source property, such as a catalog, discount, order, or email template. For a product field it will be the name of the field. For a category ID, must be a positive integer not greater than 2000000. By default, Kibo eCommerce auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the useProvidedId query string in the endpoint. For example, api/commerce/catalog/admin/categories/?useProvidedId=true. Then, use the id property to specify the desired category ID. For a product attribute it will be the Attribute FQN. For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, bba0a1a885e2413bb097ceacf7bac366 For email templates, the ID must be one of the following values:
|
changeMessage |
type: string Identifier for the object associated with the change message, which can represent a cart, cart item, or an order. |
changeMessage |
type: string The text of the change message, such as "This product is no longer available." System-supplied and read-only. |
changeMessage |
type: object Metadata content for entities, used by document lists, document type lists, document type, views, entity lists, and list views. |
changeMessage |
type: string The new value of the object affected by the change, such as the new price of the product. System-supplied and read-only. |
changeMessage |
type: string The prior value of the object affected by the change, such as the price of the product when it was added to the cart. System-supplied and read-only. |
changeMessage |
type: string The text that appears on the subject line of the message, such as "The product price has changed." |
changeMessage |
type: string Represents the type of object affected by the change, such as Cart Item or Product. System-supplied and read-only. |
changeMessage |
type: bool If true, the change associated with the message executed successfully. |
changeMessage |
type: string The user's first name. |
changeMessage |
type: string Unique identifier of the customer account (shopper or system user). System-supplied and read-only. If the shopper user is anonymous, the user ID represents a system-generated user ID string. |
changeMessage |
type: string The user's last name. |
changeMessage |
type: string The user type (e.g. Shopper, Admin, etc.). |
changeMessage |
type: string The action associated with this message. For example, if the price of a product changes, the verb could be "Increased" or "Decreased". If the product is no longer available, the verb could be "Invalidated". System-supplied and read-only. |
data |
type: Mozu.Core.Api.Contracts.Json Custom data originated by the payment service. |
externalTransactionId |
type: string The external/third party transaction Id for this payment. This is used to store the transaction Id from digital wallet like Visa Checkout |
groupId |
type: paymentActionTarget The parent group Id that this payment belongs to. This will refer to the parent checkout in the case of a multi-ship order, or the parent order in the case of a non-multi-ship order. This will (eventually) allow us to find all payments associated with a checkout, even if the payment is added directly to one of the child orders. |
paymentActionTarget |
type: string The Id of the checkout/order to target. |
paymentActionTarget |
type: int The number of the checkout/order to target. |
paymentActionTarget |
type: string Specifies if the TargetId is a checkout Id or order Id. |
id |
type: string Unique identifier of the source property, such as a catalog, discount, order, or email template. For a product field it will be the name of the field. For a category ID, must be a positive integer not greater than 2000000. By default, Kibo eCommerce auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the useProvidedId query string in the endpoint. For example, api/commerce/catalog/admin/categories/?useProvidedId=true. Then, use the id property to specify the desired category ID. For a product attribute it will be the Attribute FQN. For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, bba0a1a885e2413bb097ceacf7bac366 For email templates, the ID must be one of the following values:
|
interactions |
type: list of paymentInteraction Container for the interactions associated with the payment, which includes details for each action performed for the payment. |
paymentInteraction |
type: decimal The amount of the order-level adjustment, which can be a positive or negative amount. |
paymentInteraction |
type: auditInfo Basic audit info about the object, including date, time, and user account. This data may be captured when creating, updating, and removing data. |
paymentInteraction |
type: string Identifier of the user that created the object. System created and read only. |
paymentInteraction |
type: DateTime The date and time in UTC format set when the object was created. |
paymentInteraction |
type: string Identifier of the user that updated the entity most recently. |
paymentInteraction |
type: DateTime The date and time in UTC format the object was updated most recently. |
paymentInteraction |
type: string If applicable, the check number associated with the payment action or interaction. |
paymentInteraction |
type: string The localized currency code for the monetary amount. |
paymentInteraction |
type: string If required by the payment gateway, the authorization code of the transaction. |
paymentInteraction |
type: string AVS (Address Verification Service) codes supplied by the payment gateway. The codes indicate partial to complete or failed matches against the billing address for the shopper against the financial institute data through the gateway. |
paymentInteraction |
type: string CVV2 (Card Verification Value) codes supplied by the payment gateway. The codes indicate a verified or failed match of the encrypted code entered against the financial institution data through the gateway. |
paymentInteraction |
type: int Unique identifier of the payment interaction from the payment gateway. |
paymentInteraction |
type: string Response code from the gateway associated with the payment interaction. The response code is unique to the gateway. The response code is associated with the gatewayResponseText, which contains the textual response message. Refer to Gateway Response Code and Text in the API Guides for more information. |
paymentInteraction |
type: list of paymentGatewayResponseData Additional response data from the gateway that's unique to each gateway. This is a list of key value pairs. Refer to Gateway Response Data in the API Guides for more information. |
paymentInteraction |
type: string Key used for metadata defined for objects, including extensible attributes, custom attributes associated with a shipping provider, and search synonyms definitions. This content may be user-defined depending on the object and usage. For search synonym definitions, refer to Synonym Expansion Types for more information about the key usage. |
paymentInteraction |
type: string The value of a property, used by numerous objects within Kibo eCommerce including facets, attributes, products, localized content, metadata, capabilities (Kibo eCommerce and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type. |
paymentInteraction |
type: string Textual message returned by the payment gateway for the associated gatewayResponseCode. Refer to Gateway Response Code and Text in the API Guides for more information. |
paymentInteraction |
type: string Unique identifier of the gateway transaction associated with the payment interaction. |
paymentInteraction |
type: string Unique identifier of the source property, such as a catalog, discount, order, or email template. For a product field it will be the name of the field. For a category ID, must be a positive integer not greater than 2000000. By default, Kibo eCommerce auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the useProvidedId query string in the endpoint. For example, api/commerce/catalog/admin/categories/?useProvidedId=true. Then, use the id property to specify the desired category ID. For a product attribute it will be the Attribute FQN. For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, bba0a1a885e2413bb097ceacf7bac366 For email templates, the ID must be one of the following values:
|
paymentInteraction |
type: DateTime Date and time of a payment interaction, including handling and processing a payment and validating and completing a payment with a payment gateway. |
paymentInteraction |
type: string The type of payment interaction. The payment can be Capture or CheckReceived. The value also includes customer payment interactions such as Website, Call, Store, or Unknown. |
paymentInteraction |
type: bool If true, the payment interaction was manually defined s part of offline order processing. |
paymentInteraction |
type: bool Indicates if the product in a cart, order, or wish list is purchased on a recurring schedule. If true, the item can be purchased or fulfilled at regular intervals, such as a monthly billing cycle. For example, digital or physical product subscriptions are recurring cart items. This property is not used at this time and is reserved for future functionality. |
paymentInteraction |
type: string User-entered notation content for an object, used to save information such as payment, return, account, and order notes. |
paymentInteraction |
type: string Unique identifier of the order associated with the payment. |
paymentInteraction |
type: string The status of the payment prior to the interaction being performed, which enables manual rollback of previous transactions. |
paymentInteraction |
type: string Unique identifier of the payment associated with this transaction. |
paymentInteraction |
type: int Unique identifier of previous interaction that this payment interaction is modifying. For example, when refunding a payment, the crediting interaction would reference the capture interaction. |
paymentInteraction |
type: string The unique identifier of the refund for a given interaction. |
paymentInteraction |
type: string The unique identifier of the return associated with a given interaction. |
paymentInteraction |
type: string The current status of the object. This value is read only. Valid values for this field are: "Active", "Expired", and "Inactive". |
paymentInteraction |
type: paymentActionTarget Targets represent the object, such as an item to apply discounts to(products or orders) or a view field for content. Targets are the dot notations that link to the source document property. For example, firstitem for the direct level or firstitem.seconditem.thirditem for a deeper property. |
paymentInteraction |
type: string The Id of the checkout/order to target. |
paymentInteraction |
type: int The number of the checkout/order to target. |
paymentInteraction |
type: string Specifies if the TargetId is a checkout Id or order Id. |
isRecurring |
type: bool Indicates if the product in a cart, order, or wish list is purchased on a recurring schedule. If true, the item can be purchased or fulfilled at regular intervals, such as a monthly billing cycle. For example, digital or physical product subscriptions are recurring cart items. This property is not used at this time and is reserved for future functionality. |
orderId |
type: string Unique identifier of the order associated with the payment. |
paymentServiceTransactionId |
type: string The transaction ID supplied by the payment service to associate with this order payment. |
paymentType |
type: string The type of payment, such as credit card, check, or PayPal Express. Additional payment types will be supported in future releases. |
paymentWorkflow |
type: string The source of data for this payment. By default, this will be set to 'mozu' |
status |
type: string The current status of the object. This value is read only. Valid values for this field are: "Active", "Expired", and "Inactive". |
subPayments |
type: list of subPayment List of sub-payments that correspond to child orders in case of multiship orders. Used for tracking each order's portion of a shared payment. |
subPayment |
type: decimal The amount collected for that portion of the payment. |
subPayment |
type: decimal The amount credited back for that portion of the payment. |
subPayment |
type: decimal The amount refunded for that portion of the payment. |
subPayment |
type: decimal The amount requested for that portion of the payment. |
subPayment |
type: string The current status of the object. This value is read only. Valid values for this field are: "Active", "Expired", and "Inactive". |
subPayment |
type: paymentActionTarget Targets represent the object, such as an item to apply discounts to(products or orders) or a view field for content. Targets are the dot notations that link to the source document property. For example, firstitem for the direct level or firstitem.seconditem.thirditem for a deeper property. |
subPayment |
type: string The Id of the checkout/order to target. |
subPayment |
type: int The number of the checkout/order to target. |
subPayment |
type: string Specifies if the TargetId is a checkout Id or order Id. |
Operations
Operation Name | Request URI | Description |
---|---|---|
CreatePaymentAction | POST %7borderId%7d%2fpayments%2factions%3fresponseFields%3d%7bresponseFields%7d |
Creates a new payment transaction for the specified order and performs the specified action. |
GetAvailablePaymentActions | GET %7borderId%7d%2fpayments%2f%7bpaymentId%7d%2factions |
Retrieves the list of all available payment actions dependent on the order payment status by specifying the order ID. |
GetPayment | GET %7borderId%7d%2fpayments%2f%7bpaymentId%7d%3fresponseFields%3d%7bresponseFields%7d |
Retrieves information about a specific payment transaction submitted for the specified order. |
GetPayments | GET %7borderId%7d%2fpayments%2f%3fresponseFields%3d%7bresponseFields%7d |
Retrieves information about all payment transactions submitted for the specified order. |
PerformPaymentAction | POST %7borderId%7d%2fpayments%2f%7bpaymentId%7d%2factions%3fresponseFields%3d%7bresponseFields%7d |
Performs the specified action for an individual order payment transaction. |