Choose a version:

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.

Show input fields

Anchor to idid

•ID!

required

The payment session ID.

Anchor to paymentDetailspaymentDetails

•PaymentSessionPaymentDetails

The payment details used to process the transaction.

Show input fields

Anchor to reasonreason

•PaymentSessionRejectionReasonInput!

required

The rejection reason.

Show input fields

Was this section helpful?

Anchor to PaymentSessionRejectPayload returnsPaymentSessionRejectPayload returns

Anchor to paymentSessionpaymentSession •PaymentSession: The updated payment session.

Show fields
Anchor to userErrorsuserErrors •[UserError!]! non-null: The list of errors that occurred from executing the mutation.

Show fields

Was this section helpful?

Examples

paymentSessionReject reference

Mutation Reference

mutation paymentSessionReject($authentication: PaymentSessionThreeDSecureAuthentication, $id: ID!, $paymentDetails: PaymentSessionPaymentDetails, $reason: PaymentSessionRejectionReasonInput!) {

paymentSessionReject(authentication: $authentication, id: $id, paymentDetails: $paymentDetails, reason: $reason) {

paymentSession {

# PaymentSession fields

}

userErrors {

field

message

}

Input

{

"authentication": {

"authenticationData": {

"authenticationFlow": "CHALLENGE",

"chargebackLiability": "MERCHANT",

"dsTransactionId": "<your-dsTransactionId>",

"transStatus": "A",

"transStatusReason": "<your-transStatusReason>",

"version": "UNKNOWN"

"partnerError": "PROCESSING_ERROR"

"id": "gid://shopify/<objectName>/10079785100",

"paymentDetails": {

"cardNotPresent": {

"avsResultCode": "A",

"cvvResultCode": "I"

}

"reason": {

"code": "AMOUNT_TOO_LARGE",

"merchantMessage": "<your-merchantMessage>",

"source": "NETWORK"

}

Variables

{
  "authentication": {
    "authenticationData": {
      "authenticationFlow": "CHALLENGE",
      "chargebackLiability": "MERCHANT",
      "dsTransactionId": "<your-dsTransactionId>",
      "transStatus": "A",
      "transStatusReason": "<your-transStatusReason>",
      "version": "UNKNOWN"
    },
    "partnerError": "PROCESSING_ERROR"
  },
  "id": "gid://shopify/<objectName>/10079785100",
  "paymentDetails": {
    "cardNotPresent": {
      "avsResultCode": "A",
      "cvvResultCode": "I"
    }
  },
  "reason": {
    "code": "AMOUNT_TOO_LARGE",
    "merchantMessage": "<your-merchantMessage>",
    "source": "NETWORK"
  }
}

Schema

input PaymentSessionThreeDSecureAuthentication {
  authenticationData: PaymentSessionThreeDSecureAuthenticationData
  partnerError: PaymentSessionThreeDSecurePartnerError
}

input PaymentSessionThreeDSecureAuthenticationData {
  authenticationFlow: PaymentSessionThreeDSecureAuthenticationFlow!
  chargebackLiability: PaymentSessionThreeDSecureChargebackLiability!
  dsTransactionId: String
  transStatus: PaymentSessionThreeDSecureTransStatus!
  transStatusReason: String
  version: PaymentSessionThreeDSecureVersion!
}

input PaymentSessionPaymentDetails {
  cardNotPresent: PaymentSessionCardNotPresentInput
}

input PaymentSessionCardNotPresentInput {
  avsResultCode: PaymentSessionCardNotPresentAvsResultCode
  cvvResultCode: PaymentSessionCardNotPresentCvvResultCode
}

input PaymentSessionRejectionReasonInput {
  code: PaymentSessionStateRejectedReason!
  merchantMessage: String
  source: PaymentSessionStateRejectedSource
}