CreatePaymentInput

Input type to create a Payment.

Input Fields

ref (String!)

External reference for the Payment. Must be unique.
Max character limit: 100.

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.
Max character limit: 25.

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.
Max character limit: 25.

retailer (RetailerId!)

Retailer associated to the Payment.

amount (AmountTypeInput!)

The total amount of this Payment

paymentTransactions ([CreatePaymentTransactionWithPaymentInput!])

The PaymentTransactions associated with this Payment.

billingAccount (BillingAccountKey)

The BillingAccount associated with this Payment.

attributes ([AttributeInput])

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

financialTransaction (FinancialTransactionKey)

The FinancialTransaction associated with this Payment

fulfilment (FulfilmentKey)

The Fulfilment associated with this Payment

creditMemo (CreditMemoKey)

The CreditMemo associated with this Payment