createPaymentTransaction
This mutation creates a PaymentTransaction
, an orchestratable entity inside the Fluent ecosystem. If the PaymentTransaction
is successfully created, a CREATE event will be generate associated with the mutation.
A sample of the event generated:
{
"name": "CREATE",
"type": "NORMAL",
"entityRef": "PAYMENTTRANSACTION-001",
"entityType": "PAYMENTTRANSACTION",
"retailerId": "1",
"accountId": "ACCOUNT_ID"
}
Creates a new 'PaymentTransaction'
Input fields
CreatePaymentTransactionInput
)
Return 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 PaymentTransaction
, 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 PaymentTransaction
, typically used by the Orchestration Engine to determine the workflow that should be applied. Common types that are used are: CAPTURE
REFUND, AUTHORIZATION
String!
)
The current status of the PaymentTransaction
.
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 PaymentTransaction
.
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 PaymentServiceProvider
. This can be used to extend the existing data structure with additional data.
AmountType!
)
The amount of the PaymentTransaction
.
CurrencyLink
)
Reference to the currency type. Generally, the standard ISO-4217 is used.
Payment
)
Reference to the parent Payment.
PaymentServiceProvider
)
Associated Payment Service Provider.
The key received when executing a pre authorisation transaction. Typically used to perform a subsequent payment capture.
String
)
Card type. Some sample values are 'MASTERCARD', 'VISA', 'AMEX', 'DINERS', 'SPAN', 'DISCOVER', 'UNIONPAY', 'JCB', 'MAESTRO', 'INTERAC'
String!
)
Payment method.
WorkflowLink
)
The reference to the workflow
associated.