createPayment

This mutation creates a Payment, an orchestratable entity inside the Fluent ecosystem. If the Payment is successfully created, a CREATE event will be generate associated with the mutation.
A sample of the event generated:
{
    "name": "CREATE",
    "type": "NORMAL",
    "entityRef": "PAYMENT-001",
    "entityType": "PAYMENT",
    "retailerId": "1",
    "accountId": "ACCOUNT_ID"
}
Creates a new 'Payment'

Input fields

input (CreatePaymentInput)

Return fields

id (ID!)

ID of the object

createdOn (DateTime)

Time of creation

updatedOn (DateTime)

Time of last update

ref (String!)

External reference of the object. Must be unique.

type (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.

status (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

workflowRef (String!)
Deprecation notice

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.

workflowVersion (Int!)
Deprecation notice

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.

attributes ([Attribute])

A list of attributes associated with the Payment. This can be used to extend the existing data structure with additional data.

amount (AmountType!)

The amount of the Payment. Usually for a Payment this will equal to the Orders' total amount that this Payment was created against.

retailer (RetailerLink)

Retailer associated to the Payment.

billingAccount (BillingAccount)

Billing Account associated to the Payment.

financialTransaction (FinancialTransaction)

The FinancialTransaction associated with the Payment

fulfilment (Fulfilment)

The Fulfilment associated with the Payment

creditMemo (CreditMemo)

The CreditMemo associated with the Payment

workflow (WorkflowLink)

The reference to the workflow associated.