OrderPaymentStatus - admin-graphql - OBJECT

Version: 2024-01

Description:

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

Access Scopes

`read_orders` access scope.

Fields

  • errorMessage: String - A message describing an error during the asynchronous processing of a payment.
  • paymentReferenceId: String! - The ID of the payment, initially returned by an `orderCreateMandatePayment` or `orderCreatePayment` mutation.
  • status: OrderPaymentStatusResult! - The status of the payment.
  • translatedErrorMessage: String - A translated message describing an error during the asynchronous processing of a payment.

Connections

Related queries

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

Related mutations

Related Unions

Examples