Skip to main content
object

Requires read_orders access scope.

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

•String

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

•String!
non-null

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

•OrderPaymentStatusResult!
non-null

The status of the payment.

•[OrderTransaction!]!
non-null

The transaction associated with the payment.

Anchor to translatedErrorMessagetranslatedErrorMessage
•String

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


Was this section helpful?

•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 in the API.

The query returns an OrderPaymentStatus object that includes the current payment status, any error messages, and associated transactions. Poll this query to track asynchronous payment processing after initiating a deferred payment.

Arguments

•String!
required

Unique identifier returned by orderCreatePayment.

•ID!
required

ID of the order for which the payment was initiated.



Was this section helpful?