POST
/
carts
/
{cartId}
/
payments
/
{id}
/
actions
/
delete-attributes

Authorizations

Authorization
string
headerrequired

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

x-fabric-tenant-id
string
required

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.

x-fabric-request-id
string

Unique request ID for tracking.

x-fabric-channel-id
string

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

cartId
string
required

The 24-character system-generated Cart ID. This ID is generated using the Create cart endpoint.

id
string
required

The Payment ID that was generated when a payment was created using the Create payment endpoint.

Body

application/json

Delete Attributes Request

attributes
string[]
required

Include the attributes you wish to remove in an array containing attribute keys that remove the attributes added using the Add payment attributes endpoint.

Response

200 - application/json

Cart Payment

id
string

The Payment ID that was generated when a payment was created using the Create payment endpoint.

provider
string

The payment provider, such as Verifone, that offers functions like transaction processing, gateway management, and other financial services.

processor
string

The payment processor, such as Stripe, responsible for handling and processing payment transactions by facilitating communication between the merchant and the issuing bank.

method
string

Payment method, such as Apple Pay, used for processing transactions.

methodType
string

Payment method type, such as a credit card.

state
enum<string>

Payment state indicates whether the payment has been successfully processed.

Available options:
PENDING,
AUTHORIZED,
CAPTURED,
FAILED
authorization
object

Payment authorization

billToAddress
string

The Address ID that was generated when an address was created using the Create address endpoint.

cardDetails
object

Information about the card used for payment, such as gift card details.

attributes
object

Custom attributes associated with the transaction, such as the name of the gift card used.

Was this page helpful?

Add payment attributesDelete payment