Anchor to section titled 'undefined'

OrderPaymentStatus
object

Requires read_orders access scope.

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

Anchor to section titled 'Fields'

Fields

Anchor to OrderPaymentStatus.errorMessage
errorMessage
String

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

Anchor to OrderPaymentStatus.paymentReferenceId
paymentReferenceId
String!
non-null

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

Anchor to OrderPaymentStatus.status
status
OrderPaymentStatusResult!
non-null

The status of the payment.

Anchor to OrderPaymentStatus.transactions
transactions
[OrderTransaction!]!
non-null

The transaction associated with the payment.

Anchor to OrderPaymentStatus.translatedErrorMessage
translatedErrorMessage
String

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

Was this section helpful?
Map
  • No referencing fields
    • OrderPaymentStatus
    Anchor to section titled 'Queries'

    Queries

    Anchor to orderPaymentStatus
    orderPaymentStatus
    query

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

    Was this section helpful?
    <?>
    OrderPaymentStatus Queries
    OrderPaymentStatus

    Queried by