Order Payment Status
Requires access scope.
The status of a customer's payment for an order.
Anchor to FieldsFields
- Anchor to errorMessageerror•String
Message A message describing an error during the asynchronous processing of a payment.
- Anchor to paymentReferenceIdpayment•String!
Reference Id non-null The ID of the payment, initially returned by an
ormutation.- Anchor to statusstatus•Order
Payment Status Result! non-null The status of the payment.
- Anchor to transactionstransactions•[Order
Transaction!]! non-null The transaction associated with the payment.
- Anchor to translatedErrorMessagetranslated•String
Error Message A translated message describing an error during the asynchronous processing of a payment.
Anchor to QueriesQueries
- •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
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.- Anchor to paymentReferenceIdpayment•String!
Reference Id required Unique identifier returned by orderCreatePayment.
- Anchor to orderIdorder•ID!
Id required ID of the order for which the payment was initiated.
Arguments