Transaction Object

Properties
idstringformat GUID

Wix Payments transaction ID.

currencystringformat CURRENCY

Payment currency according to ISO 4217. For example: USD, EUR, GBP.

capturableAmountnumber

Amount that can be captured or voided in minor units. Usually matches authorization amount when the transaction has been authorized but not captured.

refundableAmountnumber

Amount that can be refunded in minor units. Usually matches capture amount when the transaction has been captured but not refunded or charged back.

externalInvoiceIdstringminLength 1maxLength 36

Invoice ID provided by the external entity that initiated the transaction.

externalOrderIdstringminLength 1maxLength 36

Order ID provided by the external entity that initiated the transaction.

externalTransactionIdstringminLength 1maxLength 36

Transaction ID provided by external entity.

providerTransactionIdstringminLength 1maxLength 1000

Transaction ID provided by the payment provider.

metadataobjectmaxItems 16format map

Metadata stored when the transaction is created.

authorizationobject

Transaction authorization information.

capturesArray <Capture>maxItems 1000

Captures issued for the transaction.

refundsArray <Refund>maxItems 1000

Refunds issued for the transaction.

disputesArray <Dispute>maxItems 1000

Disputes initiated for the transaction.

voidsArray <Void>maxItems 1000

Voids issued for the transaction.

accountIdstringformat GUID

Wix Payments account ID.

accountProfileIdstringformat GUID

Wix Payments account profile ID.

paymentMethodobject

Payment method used for payment.

Was this helpful?
Yes
No