FinancialTransaction
An order transaction defines the payment or refund details associated with an order.
Implements
Connections
PaymentConnection
)
The Payments associated with this FinancialTransaction
Argument | Type | Description |
---|---|---|
ref |
[String!]
|
External reference of the object. Must be unique. |
type |
[String!]
|
Type of the |
status |
[String!]
|
Status of the |
retailer |
RetailerLinkInput
|
|
workflow |
WorkflowLinkInput
|
|
workflowRef |
[String!]
|
DEPRECATED, please use the field |
workflowVersion |
[Int!]
|
DEPRECATED, please use the field |
createdOn |
DateRange
|
|
updatedOn |
DateRange
|
|
first |
Int
|
Returns the first n elements from the list |
last |
Int
|
Returns the last n elements from the list |
before |
String
|
Returns the elements in the list that come before the specified global ID |
after |
String
|
Returns the elements in the list that come after the specified global ID |
Fields
ID!
)
ID of the object
DateTime
)
Time of creation
DateTime
)
Time of last update
String!
)
Type of the FinancialTransaction
, typically used by the Orchestration Engine to determine the workflow that should be applied. Unless stated otherwise, no values are enforced by the platform.
String
)
The current status of the FinancialTransaction
.
By default, the initial value will be CREATED, however no other status values are enforced by the platform.
The status field is also used within ruleset selection during orchestration. For more info, see Orchestration
String!
)
The reference used for workflow identification. This is defined by a combination of the entity name and the type, in the format [EntityName]::[Type]. For example, an Order of type CC will have the workflowRef "ORDER::CC".
Int!
)
The version of the workflow assigned to the entity and used for workflow identification. It comprises a major version and minor version number.
String
)
The unique transaction reference provided by the Retailer to the payment gateway
Float!
)
The total transaction amount
Int
)
The number of digits to scale down to
Int
)
The unscaled value
String!
)
Currency used for the transaction.
String
)
The unique transaction code or request code provided by the payment gateway
String
)
The unique transaction ID or request ID provided by the payment gateway
String
)
The card type used for the payment
String
)
The way in which payment was made. Platform provides support for the following payment methods - 'CREDITCARD', 'PAYPAL', 'GIFTVOUCHER', 'CASH', 'AFTERPAY'. However, these can be overridden/configured per client as settings
String
)
The name of the payment gateway. Platform provided values are 'CYBERSOURCE', 'GIVEX', 'PAYPAL', 'BRAINTREE', 'AFTERPAY'. However, these can be overridden/configured per client as settings using 'PAYMENT.PROVIDER'
Order
)
Order associated with the transaction
[Attribute]
)