Verification Session
Requires access scope.
A unique verification transaction.
Anchor to FieldsFields
- •ID!non-null
A globally-unique ID.
- Anchor to nextActionnext•Verification
Action Session Next Action The next action expected of the partner.
- Anchor to statestate•Verification
Session States! non-null Details about the verification state.
Anchor to MutationsMutations
- •mutation
Redirects the buyer to the given URL for the verification session. Shopify will redirect the buyer to the URL where the 3DS authentication will take place when verifying the buyer's credit_card.
- •ID!required
The verification session ID.
- Anchor to redirectUrlredirect•URL!
Url required The URL that Shopify will redirect the buyer to, for 3DS authentication. Applicable to verifications with the credit card payment method only.
Arguments
- Anchor to userErrorsuser•[Verification
Errors Session User Error!]! non-null The list of errors that occurred from executing the mutation.
- Anchor to verificationSessionverification•Verification
Session Session The updated verification session.
Fields
- •ID!
- •mutation
Rejects an open verification session. After the
mutation completes on a given verification session, any
mutation attempts will fail. Subsequent
mutation attempts will succeed, but the
argument will be ignored.
- Anchor to authenticationauthentication•Verification
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 verification session ID.
- Anchor to reasonreason•Verification
Session Rejection Reason Input! required The rejection reason.
Arguments
- Anchor to userErrorsuser•[Verification
Errors Session User Error!]! non-null The list of errors that occurred from executing the mutation.
- Anchor to verificationSessionverification•Verification
Session Session The updated verification session.
Fields
- •mutation
Resolves an open verification session. After the
mutation completes on a given verification session, any
mutation attempts will fail. Subsequent
mutation attempts will succeed, but the
Details
argument will be ignored.- Anchor to authenticationauthentication•Verification
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 verification session ID.
- Anchor to networkTransactionIdnetwork•String
Transaction Id Deprecated - Anchor to paymentDetailspayment•Verification
Details Session Payment Details Input The payment details used to process the verification.
Arguments
- Anchor to userErrorsuser•[Verification
Errors Session User Error!]! non-null The list of errors that occurred from executing the mutation.
- Anchor to verificationSessionverification•Verification
Session Session The updated verification session.
Fields