Skip to main content

PaymentInput Input Type

No description

input PaymentInput {
  gateway: String!
  token: String
  amount: PositiveDecimal
  returnUrl: String
  storePaymentMethod: StorePaymentMethodEnum
  metadata: [MetadataInput!]
}

Fields​

PaymentInput.gateway ● String! non-null scalar miscellaneous​

A gateway to use with that payment.

PaymentInput.token ● String scalar miscellaneous​

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

PaymentInput.amount ● PositiveDecimal scalar miscellaneous​

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

PaymentInput.returnUrl ● String scalar miscellaneous​

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.

PaymentInput.storePaymentMethod ● StorePaymentMethodEnum enum payments​

Payment store type.

PaymentInput.metadata ● [MetadataInput!] list input miscellaneous​

User public metadata.

Member Of​

checkoutPaymentCreate mutation