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.
- •mutation
Raises a modal that will be displayed to the buyer after a checkout is completed. Included data will be used to populate the UI extension in the modal.
- •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.- •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.
- •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.
- •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.