Payment Session
Requires access scope.
A unique payment transaction.
Anchor to FieldsFields
- •Date
Time The date and time when an authorized payment session expires.
- •ID!non-null
A globally-unique ID.
- Anchor to nextActionnext•Payment
Action Session Next Action The next action expected of the partner.
- Anchor to pendingExpiresAtpending•Date
Expires At Time The date and time when a pending payment session expires.
- Anchor to statestate•Payment
Session States!non-null Details about the payment state.
Anchor to MutationsMutations
- •mutation
Initiates the confirmation process of the given payment_session.
Shopify will start confirming the payment. According to its business logic, Shopify determines if the payment can be authorized and sends a POST request to the payments app, delivering the confirmation result.
- •ID!required
The payment session ID.
Arguments
- Anchor to paymentSessionpayment•Payment
Session Session The updated payment session.
- Anchor to userErrorsuser•[Payment
Errors Session Confirm User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Change a payment session status to pending.
Upon receiving the response from the
mutation, you must redirect the customer back to Shopify, using
in
.
Upon completion, pending payments must be finalized into either a successful or failed state using the
or
mutations. Both
sale
andauthorization
payments can be marked as pending.- •ID!required
The payment session ID.
- Anchor to pendingExpiresAtpending•Date
Expires At Time!required The date and time when the pending payment expires, recommended to be within 3 days.
- Anchor to reasonreason•Payment
Session State Pending Reason!required The reason the payment is pending.
Arguments
- Anchor to paymentSessionpayment•Payment
Session Session The updated payment session.
- Anchor to userErrorsuser•[Payment
Errors Session Pending User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Redirects the buyer to the given URL for the payment session. For example, Shopify will redirect the buyer to the URL where the 3DS authentication will take place for onsite payment with
payment method.
- •ID!required
The payment session ID.
- Anchor to redirectUrlredirect•URL!required
Url The URL that Shopify will redirect the buyer to, for 3DS authentication. Applicable to payments with the credit card payment method only.
Arguments
- Anchor to paymentSessionpayment•Payment
Session Session The updated payment session.
- Anchor to userErrorsuser•[Payment
Errors Session Redirect User 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 paymentDetailspayment•Payment
Details Session Payment Details The payment details used to process the transaction.
- 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.
- Anchor to paymentDetailspayment•Payment
Details Session Payment Details The payment details used to process the transaction.
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