orderPaymentStatus

Requires a customer (portal or buyer app) session.

Returns the live payment status for an order. Scoped to the authenticated buyer — another buyer's order returns not-found.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query OrderPaymentStatus($orderId: ID!) {
  orderPaymentStatus(orderId: $orderId) {
    errorCode
    status
    errorMessage
    orderId
    orderStatus
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query OrderPaymentStatus($orderId: ID!) {\n  orderPaymentStatus(orderId: $orderId) {\n    errorCode\n    status\n    errorMessage\n    orderId\n    orderStatus\n  }\n}",
  "variables": {
    "orderId": "id"
  }
}
EOF

Variables:

{
  "orderId": "id"
}

Response:

{
  "data": {
    "orderPaymentStatus": {
      "errorCode": "string",
      "status": "CANCELLED",
      "errorMessage": "string",
      "orderId": "id",
      "orderStatus": "string"
    }
  }
}

orderPaymentStatus(
  orderId: ID!
): MobileOrderPaymentStatus!

Arguments

orderPaymentStatus.orderId ● ID! non-null scalar

The ID of the order.

Type

MobileOrderPaymentStatus object

Live payment status for an order: combines order status + latest transaction status.