Skip to main content
Shopify.devShopify.devDocs
Log inSign up

Shopify uses cookies to provide necessary site functionality and improve your experience. By using our website, you agree to our privacy policy and our cookie policy.

Anchor to orderPaymentStatus

orderPaymentStatus

query

Returns a payment status by payment reference ID. Used to check the status of a deferred payment.

Anchor to Arguments

Arguments

Anchor to orderIdorderId
•
ID!required

ID of the order for which the payment was initiated.

Anchor to paymentReferenceIdpaymentReferenceId
•
String!required

Unique identifier returned by orderCreatePayment.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to OrderPaymentStatusOrderPaymentStatus
•
OrderPaymentStatus

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

errorMessage•
String

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

paymentReferenceId•
String!
non-null

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

status•
OrderPaymentStatusResult!
non-null

The status of the payment.

transactions•
[OrderTransaction!]!
non-null

The transaction associated with the payment.

translatedErrorMessage•
String

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

Was this section helpful?