Payment
The Payment information
Implements
Connections
OrderConnection
)
Orders associated with the Payment
.
Argument | Type | Description |
---|---|---|
ref |
[String]
|
External reference of the object. Must be unique. |
type |
[String!]
|
Type of the Order, typically used by the Orchestration Engine to determine the workflow that should be applied. Unless stated otherwise, no values are enforced by the platform. Currently supports all values. |
status |
[String]
|
The current status of the Order. |
workflowRef |
[String!]
|
The workflow's reference |
workflowVersion |
[Int!]
|
The version of the workflow |
createdOn |
DateRange
|
|
updatedOn |
DateRange
|
|
totalPrice |
[Float]
|
Total price |
totalTaxPrice |
[Float]
|
Total tax price |
customerLink |
CustomerLinkInput
|
|
payment |
PaymentLinkInput
|
|
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 |
retailerId |
[Int!]
|
ID of the retailer |
PaymentTransactionConnection
)
Payment Transactions associated with the Payment
.
Argument | Type | Description |
---|---|---|
ref |
[String!]
|
External reference of the object. Must be unique. |
type |
[String!]
|
Type of the |
status |
[String!]
|
Status of the |
currency |
CurrencyLinkInput
|
|
authorizationKey |
[String]
|
The key received when executing a pre authorisation transaction. Typically used to perform a subsequent payment capture. |
cardType |
[String]
|
Card type. Some sample values are 'MASTERCARD', 'VISA', 'AMEX', 'DINERS', 'SPAN', 'DISCOVER', 'UNIONPAY', 'JCB', 'MAESTRO', 'INTERAC' |
paymentMethod |
[String!]
|
Payment method. |
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!
)
External reference of the object. Must be unique.
String!
)
Type of the Payment
, typically used by the Orchestration Engine to determine the workflow that should be applied. Unless stated otherwise, no values are enforced by the platform.
Type of the Payment
, typically used by the Orchestration Engine to determine the workflow that should be applied. For Payment a sample value for this is DEFAULT
.
String!
)
The current status of the Payment
.
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
Status of the Payment
String!
)
No longer supported
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".
DEPRECATED, please use the field workflow
instead - The reference of the workflow.
Int!
)
No longer supported
The version of the workflow assigned to the entity and used for workflow identification. It comprises a major version and minor version number.
DEPRECATED, please use the field workflow
instead - The version of the workflow.
[Attribute]
)
A list of attributes associated with the Payment
. This can be used to extend the existing data structure with additional data.
AmountType!
)
The amount of the Payment
. Usually for a Payment this will equal to the Order
s' total amount that this Payment was created against.
RetailerLink
)
Retailer associated to the Payment
.
BillingAccount
)
Billing Account associated to the Payment
.
FinancialTransaction
)
The FinancialTransaction associated with the Payment
Fulfilment
)
The Fulfilment associated with the Payment
CreditMemo
)
The CreditMemo associated with the Payment
WorkflowLink
)
The reference to the workflow
associated.