Skip to main content

PaymentInput

No description

input PaymentInput {
gateway: String!
token: String
amount: PositiveDecimal
volumeDiscount: PositiveDecimal
billingAddress: AddressInput
returnUrl: String
}

Fields

PaymentInput.gateway ● String! non-null scalar

A gateway to use with that payment.

PaymentInput.token ● String scalar

Client-side generated payment token, representing customer's billing data in a secure manner.

PaymentInput.amount ● PositiveDecimal scalar

Total amount of the transaction, including all taxes and discounts. If no amount is provided, the checkout total will be used.

PaymentInput.volumeDiscount ● PositiveDecimal scalar

Volume discount applicable to the checkout

PaymentInput.billingAddress ● AddressInput input

[Deprecated] Billing address. If empty, the billing address associated with the checkout instance will be used. Use checkoutCreate or checkoutBillingAddressUpdate mutations to set it. This field will be removed after 2020-07-31.

PaymentInput.returnUrl ● String scalar

URL of a storefront view where user should be redirected after requiring additional actions. Payment with additional actions will not be finished if this field is not provided.

Member Of

checkoutPaymentCreate mutation ● nauticalOrderPaymentCreate mutation

Was this page helpful?