Skip to main content
Anchor to PaymentDetails

PaymentDetails

union

Requires read_orders access scope.

Payment details related to a transaction.

Anchor to Possible typesPossible types

Anchor to CardPaymentDetailsCardPaymentDetails
•OBJECT

Credit card payment information captured during a transaction. Includes cardholder details, card metadata, verification response codes, and the DigitalWallet when used.

Anchor to LocalPaymentMethodsPaymentDetailsLocalPaymentMethodsPaymentDetails
•OBJECT

Local payment methods payment details related to a transaction.

Anchor to PaypalWalletPaymentDetailsPaypalWalletPaymentDetails
•OBJECT

PayPal Wallet payment details related to a transaction.

Anchor to ShopPayInstallmentsPaymentDetailsShopPayInstallmentsPaymentDetails
•OBJECT

Shop Pay Installments payment details related to a transaction.

Was this section helpful?

Anchor to Fields with this unionFields with this union

Anchor to OrderTransaction.paymentDetailsOrderTransaction.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.paymentDetailsSuggestedOrderTransaction.paymentDetails
•OBJECT

A suggested transaction. Suggested transaction are usually used in the context of refunds and exchanges.

Was this section helpful?