orderPaymentStatus - admin-graphql - QUERY
Version: unstable
Description:
Returns a payment status by payment reference ID. Used to check the status of a deferred payment.
Access Scopes
Arguments
-
orderId:
ID! -
ID of the order for which the payment was initiated.
-
paymentReferenceId:
String! -
Unique identifier returned by orderCreatePayment.
Returns
-
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.
-
transactions:
OrderTransaction!
The transaction associated with the payment.
-
translatedErrorMessage:
String
A translated message describing an error during the asynchronous processing of a payment.
Examples