---
title: PaymentSessionStates - Payments Apps API
description: The possible values that can be used to describe the state of a payment transaction.
api_version: 2025-01
api_name: payments-apps
type: union
api_type: graphql
source_url:
  html: https://shopify.dev/docs/api/payments-apps/2025-01/unions/PaymentSessionStates
  md: https://shopify.dev/docs/api/payments-apps/2025-01/unions/PaymentSessionStates.md
---

# Payment​Session​States

union

Requires `read_payment_sessions` access scope.

The possible values that can be used to describe the state of a payment transaction.

## Possible types

* [Payment​Session​State​Confirming](https://shopify.dev/docs/api/payments-apps/2025-01/objects/PaymentSessionStateConfirming)

  OBJECT

  Additional details about a payment's confirming state.

  * code

    [Payment​Session​State​Code!](https://shopify.dev/docs/api/payments-apps/2025-01/enums/PaymentSessionStateCode)

    non-null

    The payment state code.

* [Payment​Session​State​Pending](https://shopify.dev/docs/api/payments-apps/2025-01/objects/PaymentSessionStatePending)

  OBJECT

  Additional details about a payment's pending state.

  * code

    [Payment​Session​State​Code!](https://shopify.dev/docs/api/payments-apps/2025-01/enums/PaymentSessionStateCode)

    non-null

    The payment state code.

  * reason

    [Payment​Session​State​Pending​Reason](https://shopify.dev/docs/api/payments-apps/2025-01/enums/PaymentSessionStatePendingReason)

    The reason the payment is pending.

* [Payment​Session​State​Redirecting](https://shopify.dev/docs/api/payments-apps/2025-01/objects/PaymentSessionStateRedirecting)

  OBJECT

  Additional details about a payment's redirecting state.

  * code

    [Payment​Session​State​Code!](https://shopify.dev/docs/api/payments-apps/2025-01/enums/PaymentSessionStateCode)

    non-null

    The payment state code.

* [Payment​Session​State​Rejected](https://shopify.dev/docs/api/payments-apps/2025-01/objects/PaymentSessionStateRejected)

  OBJECT

  Additional details about a payment's rejected state.

  * code

    [Payment​Session​State​Code!](https://shopify.dev/docs/api/payments-apps/2025-01/enums/PaymentSessionStateCode)

    non-null

    The payment state code.

  * merchant​Message

    [String](https://shopify.dev/docs/api/payments-apps/2025-01/scalars/String)

    The custom, localized message for the merchant.

  * reason

    [Payment​Session​State​Rejected​Reason!](https://shopify.dev/docs/api/payments-apps/2025-01/enums/PaymentSessionStateRejectedReason)

    non-null

    The reason the payment is rejected.

* [Payment​Session​State​Resolved](https://shopify.dev/docs/api/payments-apps/2025-01/objects/PaymentSessionStateResolved)

  OBJECT

  Additional details about a payment's resolved state.

  * code

    [Payment​Session​State​Code!](https://shopify.dev/docs/api/payments-apps/2025-01/enums/PaymentSessionStateCode)

    non-null

    The payment state code.

***

## Fields with this union

* [Payment​Session.​state](https://shopify.dev/docs/api/payments-apps/2025-01/objects/PaymentSession#field-state)

  OBJECT

  A unique payment transaction.

***

```graphql
union PaymentSessionStates = PaymentSessionStateConfirming | PaymentSessionStatePending | PaymentSessionStateRedirecting | PaymentSessionStateRejected | PaymentSessionStateResolved
```