User Error
Represents an error in the input of a mutation.
Anchor to FieldsFields
- 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
- •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.
- 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
- Anchor to paymentsAppConfigurationpayments•Payments
App Configuration App Configuration The production configuration of the payments app.
- Anchor to userErrorsuser•[User
Errors Error!]! non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Rejects an open payment session. After the
mutation completes on a given payment session, any
mutation attempts will fail. Subsequent
mutation attempts will succeed, but the
argument will be ignored.
- 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.
- •ID!required
The payment session ID.
- Anchor to reasonreason•Payment
Session Rejection Reason Input! required The rejection reason.
Arguments
- Anchor to paymentSessionpayment•Payment
Session Session The updated payment session.
- Anchor to userErrorsuser•[User
Errors Error!]! non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Resolves an open payment session. After the
mutation completes on a given payment session, any
mutation attempts will fail. Subsequent
mutation attempts will succeed, but the
Details
argument will be ignored.- 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.
- •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.
Arguments
- Anchor to paymentSessionpayment•Payment
Session Session The updated payment session.
- Anchor to userErrorsuser•[User
Errors Error!]! non-null The list of errors that occurred from executing the mutation.
Fields