User
An error in the input of a mutation. Mutations return objects to
indicate validation failures, such as invalid field values or business logic
violations, that prevent the operation from completing.
Anchor to FieldsFields
- field ([String!])
- message (String!)
- Anchor to fieldfield•[String!]
The path to the input field that caused the error.
- Anchor to messagemessage•String!non-null
The error message.
Anchor to MutationsMutations
- paymentsAppConfigure (PaymentsAppConfigurePayload)
- paymentSessionReject (PaymentSessionRejectPayload)
- paymentSessionResolve (PaymentSessionResolvePayload)
- •mutation
Configures the partner-managed payments gateway to work on the merchant's store. For an example of how to use the
mutation, refer to the tutorial for onboarding merchants to payments extensions.Show payload
- Anchor to externalHandleexternal•String
Handle Handle used in the external system.
- Anchor to readyready•Boolean!required
The provider is ready to process merchant's payments.
Arguments
- •mutation
Rejects an open payment session. After the
mutation completes on a given payment session, anymutation attempts will fail. Subsequentmutation attempts will succeed, but theargument will be ignored.Show payload
- Anchor to authenticationauthentication•Payment
Session Three DSecure Authentication The 3D Secure authentication data from the partner. Must be present if and only if the Redirect mutation has been called and the payment method is credit card.
Show input fields
- •ID!required
The payment session ID.
- Anchor to paymentDetailspayment•Payment
Details Session Payment Details The payment details used to process the transaction.
Show input fields
- Anchor to reasonreason•Payment
Session Rejection Reason Input! required The rejection reason.
Show input fields
Arguments
- •mutation
Resolves an open payment session. After the
mutation completes on a given payment session, anymutation attempts will fail. Subsequentmutation attempts will succeed, but theDetailsargument will be ignored.Show payload
- Anchor to authenticationauthentication•Payment
Session Three DSecure Authentication The 3D Secure authentication data from the partner. Must be present if and only if the Redirect mutation has been called and the payment method is credit card.
Show input fields
- •Date
Time The date and time when an authorized payment session expires.
- •ID!required
The payment session ID.
- Anchor to networkTransactionIdnetwork•String
Transaction Id The transaction ID issued by the network when processing the payment.
- Anchor to paymentDetailspayment•Payment
Details Session Payment Details The payment details used to process the transaction.
Show input fields
Arguments