PaymentInput Input Type
Fields required to create a payment.
The legacy Payments API is deprecated and will be removed. Use the Transactions API instead.
input PaymentInput {
gateway: String!
token: String
amount: PositiveDecimal
returnUrl: String
storePaymentMethod: StorePaymentMethodEnum = NONE
metadata: [MetadataInput!]
}Fields
gateway
gateway · String!
A gateway to use with that payment.
token
token · String
Client-side generated payment token, representing customer’s billing data in a secure manner.
amount
amount · PositiveDecimal
Total amount of the transaction, including all taxes and discounts. If no amount is provided, the checkout total will be used.
returnUrl
returnUrl · String
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.
storePaymentMethod
storePaymentMethod · StorePaymentMethodEnum
Payment store type.
Default: NONE.
metadata
metadata · [MetadataInput!]
User public metadata. Can be read by any API client authorized to read the object it’s attached to.
Warning: never store sensitive information, including financial data such as credit card details.
Used by
Schema: Saleor 3.23.43. Download SDL.