Skip to main content
Anchor to paymentSessionReject

paymentSessionReject

mutation

Requires write_payment_sessions access scope.

Rejects an open payment session. After the paymentSessionReject mutation completes on a given payment session, any paymentSessionResolve mutation attempts will fail. Subsequent paymentSessionReject mutation attempts will succeed, but the RejectionReasonInput argument will be ignored.

Anchor to Arguments

Arguments

Anchor to authenticationauthentication
•PaymentSessionThreeDSecureAuthentication

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.

Anchor to idid
•ID!required

The payment session ID.

Anchor to reasonreason
•PaymentSessionRejectionReasonInput!required

The rejection reason.

Was this section helpful?

Anchor to PaymentSessionRejectPayload returnsPaymentSessionRejectPayload returns

Anchor to paymentSessionpaymentSession
•PaymentSession

The updated payment session.

Anchor to userErrorsuserErrors
•[UserError!]!non-null

The list of errors that occurred from executing the mutation.

Was this section helpful?