PaymentTransaction

A PaymentTransaction represents a payment transaction for an Order via your payment gateway.

Properties

Name

Type

Description

Id

int

The ID of the payment transaction.

OrderId

int

The ID of the order that the transaction belongs to.

Order (via $expand)

Order

The order that the transaction belongs to.

Submitted

datetimeoffset

The date/time the transaction was posted to the payment gateway.

TransactionId

string

The transaction ID returned by the payment gateway, if applicable.

IsApproved

boolean

Flag that indicates whether the transaction was approved.

ResponseCode

string

The response code returned by the payment gateway, if applicable.

AuthCode

string

The authorization code returned by the payment gateway, if applicable.

Message

string

The more verbose response from the payment gateway.

Amount

decimal(18,2)

The amount authorized or captured.

TransactionType

string

The type of transaction. Valid values include AuthOnly, AuthCapture, PriorAuthCapture, and Refund.

Gateway

string

The name of the payment gateway.

GatewayEnvironment

string

The gateway environment used for the transaction. Valid values include Live and Sandbox.