CreatePaymentTransactionInput

Input type to create a PaymentTransaction.

Input Fields

ref (String!)

External reference to the PaymentTransaction. Must be unique.
Max character limit: 100.

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

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

amount (AmountTypeInput!)

The total amount of this PaymentTransaction

currency (CurrencyKey!)

The currency used in this Payment.

authorizationKey (String)

The Authorization Key of this PaymentTransaction if it is of 'PreAuth'.
Max character limit: 50.

cardType (String)

The Card type used in this PaymentTransaction. Some example values are: 'MASTERCARD', 'VISA', 'AMEX', 'DINERS', 'SPAN', 'DISCOVER', 'UNIONPAY', 'JCB', 'MAESTRO', 'INTERAC'.
Max character limit: 25.

paymentMethod (String!)

The payment method used in this PaymentTransaction. Some example values are: 'CREDITCARD', 'GIFTCARD', 'COUPON'.
Max character limit: 25.

payment (PaymentKey!)

The 'Payment' associated with this PaymentTransaction

paymentServiceProvider (PaymentServiceProviderKey!)

The payment servicer provider for this PaymentTransaction

attributes ([AttributeInput])

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