CData Python Connector for Shopify

Build 25.0.9454

OrderTransactions

Stores payment transaction records for orders, including authorizations, captures, and refunds.

Table-Specific Information

Select

The connector uses the Shopify API to process WHERE clause conditions built with the following column and operators. The connector processes other filters client-side within the connector.

  • ResourceId supports the '=, IN' comparison operators.

For example, the following query is processed server-side:

  SELECT * FROM OrderTransactions WHERE ResourceId = 'Val1'

Insert

The following columns can be used to create a new record:

ResourceId, ParentTransactionId

The following pseudo-columns can be used to create a new record:

Amount, Currency, FinalCapture

Columns

Name Type ReadOnly References Description
Id [KEY] String True

A globally unique identifier for the transaction record.

ResourceId [KEY] String True

Orders.Id

A globally unique identifier linking this transaction to its associated resource, such as an order or payment.

PaymentId String True

The unique identifier for the payment associated with this transaction, as provided by the payment gateway or Shopify Payments.

ParentTransactionId String True

References the parent transaction, such as an authorization related to a subsequent capture or refund.

AccountNumber String True

The masked account number for the payment method used, with sensitive digits redacted for security.

Gateway String True

The payment gateway that processed the transaction, such as Shopify Payments, PayPal, or another provider.

Kind String True

Specifies the type of transaction, such as authorization, capture, sale, or refund.

Status String True

The current processing state of the transaction, such as pending, succeeded, or failed.

Test Bool True

Indicates whether this transaction was processed in test mode rather than live mode.

AuthorizationCode String True

The code returned by the payment provider confirming authorization of the transaction.

ErrorCode String True

A standardized error identifier that represents the reason for a failed transaction, independent of the gateway provider.

FormattedGateway String True

The human-readable name of the payment gateway displayed in Shopify reports or the admin interface.

ManuallyCapturable Bool True

Indicates whether this transaction can be manually captured by a merchant after authorization.

MultiCapturable Bool True

Specifies whether multiple captures can be made from a single authorization.

ProcessedAt Datetime True

The timestamp indicating when the transaction was processed by the payment provider.

ReceiptJson String True

A JSON-formatted receipt containing payment gateway–specific transaction details or metadata.

SettlementCurrency String True

The currency in which the transaction was settled, as determined by the payment processor.

AuthorizationExpiresAt Datetime True

The expiration date and time for the authorization. Available only for Shopify Payments merchants on Shopify Plus.

SettlementCurrencyRate Decimal True

The exchange rate applied when converting the transaction amount into the settlement currency.

CreatedAt Datetime True

The date and time when the transaction record was originally created in Shopify.

CardPaymentDetailsName String True

The name of the cardholder as it appears on the credit card.

CardPaymentDetailsBin String True

The issuer identification number (IIN), formerly known as the bank identification number (BIN), derived from the first few digits of the card number.

CardPaymentDetailsCompany String True

The name of the credit card company or issuing bank associated with the customer's card.

CardPaymentDetailsNumber String True

The customer's credit card number with leading digits redacted for privacy.

CardPaymentDetailsWallet String True

Specifies the digital wallet used for payment, such as Apple Pay or Google Pay.

CardPaymentDetailsExpirationMonth Int True

The expiration month of the credit card used for the transaction.

CardPaymentDetailsExpirationYear Int True

The expiration year of the credit card used for the transaction.

CardPaymentDetailsAvsResultCode String True

A one-letter code indicating the result of the Address Verification System (AVS) check.

CardPaymentDetailsCvvResultCode String True

A one-letter or blank code indicating the result of the CVV (security code) validation performed by the payment provider.

PaymentIconId String True

The unique identifier of the payment method's icon image.

PaymentIconWidth Int True

The width of the payment icon in pixels. Returns null if the image is not hosted by Shopify.

PaymentIconAltText String True

Alternative text describing the image for accessibility or descriptive purposes.

PaymentIconHeight Int True

The height of the payment icon in pixels. Returns null if the image is not hosted by Shopify.

AmountSetPresentmentMoneyAmount Decimal True

The transaction amount shown in the buyer's currency (presentment currency), expressed as a decimal value.

AmountSetPresentmentMoneyCurrencyCode String True

The ISO 4217 currency code for the presentment currency, such as USD or GBP.

AmountSetShopMoneyAmount Decimal True

The transaction amount converted to the shop's base currency for accounting purposes.

AmountSetShopMoneyCurrencyCode String True

The ISO 4217 currency code for the shop's base currency, such as USD or CAD.

MaximumRefundableV2Amount Decimal True

The maximum refundable amount for this transaction, expressed as a decimal value.

MaximumRefundableV2CurrencyCode String True

The ISO 4217 currency code corresponding to the maximum refundable amount.

ShopifyPaymentsSetExtendedAuthorizationSetExtendedAuthorizationExpiresAt Datetime True

The expiration time for an extended authorization, after which the merchant cannot capture the payment.

ShopifyPaymentsSetExtendedAuthorizationSetStandardAuthorizationExpiresAt Datetime True

The expiration time for a standard authorization after which additional capture fees may apply.

ShopifyPaymentsSetRefundSetAcquirerReferenceNumber String True

The acquirer reference number (ARN) generated for Visa or Mastercard transactions to trace settlements.

TotalUnsettledSetPresentmentMoneyAmount Decimal True

The portion of funds still unsettled in the presentment currency.

TotalUnsettledSetPresentmentMoneyCurrencyCode String True

The ISO 4217 currency code for the presentment currency of unsettled funds.

TotalUnsettledSetShopMoneyAmount Decimal True

The portion of funds still unsettled in the shop's base currency.

TotalUnsettledSetShopMoneyCurrencyCode String True

The ISO 4217 currency code for the shop's base currency of unsettled funds.

UserId String True

The identifier of the staff member logged into the Shopify POS device that processed the transaction. Available only for Shopify Plus accounts.

AmountRoundingSetPresentmentMoneyAmount Decimal True

The precise tax or rounding adjustment amount in the customer's presentment currency, represented as a decimal (for example, 12.99).

AmountRoundingSetPresentmentMoneyCurrencyCode String True

The ISO 4217 code of the presentment currency related to the rounding adjustment.

AmountRoundingSetShopMoneyAmount Decimal True

The precise tax or rounding adjustment amount in the shop's base currency, represented as a decimal (for example, 12.99).

AmountRoundingSetShopMoneyCurrencyCode String True

The ISO 4217 code of the shop's base currency related to the rounding adjustment.

PaymentDetailsLocalPaymentDescriptor String True

The payment descriptor assigned by the payment provider. Applies to providers such as Amazon Pay or Buy with Prime.

PaymentDetailsLocalPaymentMethodName String True

The specific local payment method used by the buyer, such as Klarna or iDEAL.

PaymentDetailsShopPayInstallmentsPaymentMethodName String True

The name of the installment payment method used through Shop Pay Installments.

PaymentDetailsCardAvsResultCode String True

A one-letter code representing the result of the AVS check for card-based payments.

PaymentDetailsCardBin String True

The issuer identification number (IIN/BIN) from the customer's credit card, composed of the initial digits of the card number.

PaymentDetailsCardCompany String True

The issuing bank or credit card company for the customer's card.

PaymentDetailsCardCvvResultCode String True

A one-letter or blank code indicating whether the card's security code (CVV) was successfully validated.

PaymentDetailsCardExpirationMonth Int True

The expiration month for the customer's card used in the transaction.

PaymentDetailsCardExpirationYear Int True

The expiration year for the customer's card used in the transaction.

PaymentDetailsCardName String True

The full name of the cardholder as printed on the credit card.

PaymentDetailsCardNumber String True

The customer's credit card number with most leading digits redacted.

PaymentDetailsCardPaymentMethodName String True

The payment method name as identified by the payment processor.

PaymentDetailsCardWallet String True

Specifies the digital wallet used for payment, such as Apple Pay or Google Pay.

Pseudo-Columns

Pseudo-columns are fields that can only be used in the types of statements under which they are explicitly listed. They are not standard columns but instead provide additional functionality for specific operations.

Name Type Description
Amount Decimal

The amount to capture during authorization. This value cannot exceed the originally authorized amount.

Currency String

The ISO 4217 currency code of the transaction amount to capture.

FinalCapture Bool

Indicates whether this capture is the final one for the authorization. If true, any remaining authorization balance will be voided after capture.

DeviceId String

The identifier of the POS device or terminal that processed the transaction.

GiftCardDetailsId String

The identifier of the gift card used to pay for this transaction, if applicable.

LocationId String

The identifier of the store or location where the transaction occurred.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9454