Create payment
Adds a payment method to the corresponding cart to process a transaction.
The Cart ID from the Create cart endpoint is used in the path parameter.
Authorizations
This is the authorization token used to authenticate the request. You must pass the access token generated from the system app. For more information, see the Making your first API request section.
Headers
A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.
Unique request ID for tracking.
x-fabric-channel-id identifies the sales channel through which the API request is being made; primarily for multichannel use cases. It is a required field. The default US channel is 12 while the default Canada channel is 11.
Path Parameters
The 24-character system-generated Cart ID. This ID is generated using the Create cart endpoint.
Body
Payment Request
The payment provider, such as Verifone, that offers functions like transaction processing, gateway management, and other financial services.
The payment processor, such as Stripe, responsible for handling and processing payment transactions by facilitating communication between the merchant and the issuing bank.
Payment method
Payment method type
Payment state
PENDING
, AUTHORIZED
, CAPTURED
, FAILED
Payment authorization
The Address ID that was generated when an address was created using the Create address endpoint.
Information about the card used for payment, such as gift card details.
Custom attributes associated with the transaction, such as the name of the gift card used.
Response
Cart Payment
The unique identifier for the payment generated in this response, used for referencing in other endpoints.
The payment provider, such as Verifone, that offers functions like transaction processing, gateway management, and other financial services.
The payment processor, such as Stripe, responsible for handling and processing payment transactions by facilitating communication between the merchant and the issuing bank.
Payment method, such as Apple Pay, used for processing transactions.
Payment method type, such as a credit card.
Payment state indicates whether the payment has been successfully processed.
PENDING
, AUTHORIZED
, CAPTURED
, FAILED
Payment authorization
The Address ID that was generated when an address was created using the Create address endpoint.
Information about the card used for payment, such as gift card details.
Custom attributes associated with the transaction, such as the name of the gift card used.
Was this page helpful?