---
title: orderPaymentStatus - GraphQL Admin
description: |-
  Retrieves the status of a deferred payment by its payment reference ID. Use this query to monitor the processing status of payments that are initiated through payment mutations. Deferred payments are called [payment terms](https://shopify.dev/docs/apps/build/checkout/payments/payment-terms) in the API.

  The query returns an [`OrderPaymentStatus`](https://shopify.dev/docs/api/admin-graphql/latest/objects/OrderPaymentStatus) object that includes the current payment status, any error messages, and associated transactions. Poll this query to track [asynchronous payment processing](https://shopify.dev/docs/apps/build/payments/processing) after initiating a deferred payment.
api_version: unstable
api_name: admin
source_url:
  html: https://shopify.dev/docs/api/admin-graphql/unstable/queries/orderpaymentstatus
  md: https://shopify.dev/docs/api/admin-graphql/unstable/queries/orderpaymentstatus.md
---

# order​Payment​Status

query

Retrieves the status of a deferred payment by its payment reference ID. Use this query to monitor the processing status of payments that are initiated through payment mutations. Deferred payments are called [payment terms](https://shopify.dev/docs/apps/build/checkout/payments/payment-terms) in the API.

The query returns an [`OrderPaymentStatus`](https://shopify.dev/docs/api/admin-graphql/latest/objects/OrderPaymentStatus) object that includes the current payment status, any error messages, and associated transactions. Poll this query to track [asynchronous payment processing](https://shopify.dev/docs/apps/build/payments/processing) after initiating a deferred payment.

## Arguments

* order​Id

  [ID!](https://shopify.dev/docs/api/admin-graphql/unstable/scalars/ID)

  required

  ID of the order for which the payment was initiated.

* payment​Reference​Id

  [String!](https://shopify.dev/docs/api/admin-graphql/unstable/scalars/String)

  required

  Unique identifier returned by orderCreatePayment.

***

## Possible returns

* Order​Payment​Status

  [Order​Payment​Status](https://shopify.dev/docs/api/admin-graphql/unstable/objects/OrderPaymentStatus)

  The status of a customer's payment for an order.

  * error​Message

    [String](https://shopify.dev/docs/api/admin-graphql/unstable/scalars/String)

    A message describing an error during the asynchronous processing of a payment.

  * payment​Reference​Id

    [String!](https://shopify.dev/docs/api/admin-graphql/unstable/scalars/String)

    non-null

    The ID of the payment, initially returned by an `orderCreateMandatePayment` or `orderCreatePayment` mutation.

  * status

    [Order​Payment​Status​Result!](https://shopify.dev/docs/api/admin-graphql/unstable/enums/OrderPaymentStatusResult)

    non-null

    The status of the payment.

  * transactions

    [\[Order​Transaction!\]!](https://shopify.dev/docs/api/admin-graphql/unstable/objects/OrderTransaction)

    non-null

    The transaction associated with the payment.

  * translated​Error​Message

    [String](https://shopify.dev/docs/api/admin-graphql/unstable/scalars/String)

    A translated message describing an error during the asynchronous processing of a payment.

***

## Examples

* ### orderPaymentStatus reference

## Query Reference

```graphql
{
  orderPaymentStatus(paymentReferenceId, orderId) {
    # orderPaymentStatus fields
  }
}
```