Choose a version:

PaymentDetails

union

Requires read_orders access scope.

Payment details related to a transaction.

Anchor to Possible typesPossible types

•OBJECT

Card payment details related to a transaction.

Anchor to avsResultCodeavsResultCode •String: The response code from the address verification system (AVS). The code is always a single letter.
Anchor to binbin •String: The issuer identification number (IIN), formerly known as bank identification number (BIN) of the customer's credit card. This is made up of the first few digits of the credit card number.
Anchor to companycompany •String: The name of the company that issued the customer's credit card.
Anchor to cvvResultCodecvvResultCode •String: The response code from the credit card company indicating whether the customer entered the card security code, or card verification value, correctly. The code is a single letter or empty string.
Anchor to expirationMonthexpirationMonth •Int: The month in which the used credit card expires.
Anchor to expirationYearexpirationYear •Int: The year in which the used credit card expires.
Anchor to namename •String: The holder of the credit card.
Anchor to numbernumber •String: The customer's credit card number, with most of the leading digits redacted.
Anchor to paymentMethodNamepaymentMethodName •String: The name of payment method used by the buyer.
Anchor to walletwallet •DigitalWallet: Digital wallet used for the payment.

•OBJECT

Local payment methods payment details related to a transaction.

Anchor to paymentDescriptorpaymentDescriptor •String: The descriptor by the payment provider. Only available for Amazon Pay and Buy with Prime.
Anchor to paymentMethodNamepaymentMethodName •String: The name of payment method used by the buyer.

•OBJECT

PayPal Wallet payment details related to a transaction.

Anchor to paymentMethodNamepaymentMethodName •String: The name of payment method used by the buyer.

•OBJECT

Shop Pay Installments payment details related to a transaction.

Anchor to paymentMethodNamepaymentMethodName •String: The name of payment method used by the buyer.

Was this section helpful?

Anchor to OrderTransaction.paymentDetails OrderTransaction.paymentDetails •OBJECT: The OrderTransaction object represents a payment transaction that's associated with an order. An order transaction is a specific action or event that happens within the context of an order, such as a customer paying for a purchase or receiving a refund, or other payment-related activity.

Use the OrderTransaction object to capture the complete lifecycle of a payment, from initial authorization to final settlement, including refunds and currency exchanges. Common use cases for using the OrderTransaction object include:

Processing new payments for orders

Managing payment authorizations and captures

Processing refunds for returned items

Tracking payment status and errors

Managing multi-currency transactions

Handling payment gateway integrations

Each OrderTransaction object has a kind that defines the type of transaction and a status that indicates the current state of the transaction. The object stores detailed information about payment methods, gateway processing, and settlement details.

Learn more about payment processing and payment gateway integrations.
Anchor to SuggestedOrderTransaction.paymentDetails SuggestedOrderTransaction.paymentDetails •OBJECT: A suggested transaction. Suggested transaction are usually used in the context of refunds and exchanges.

Was this section helpful?