customerOrderPaymentOverlays

Requires a customer (portal or buyer app) session.

"Payment under review" overlays for a batch of orders (AWAITING_PAYMENT + pending COLLECTION payment — DERIVED, never a backend status). screen 8.

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 CustomerOrderPaymentOverlays($orderIds: [ID!]!) {
  customerOrderPaymentOverlays(orderIds: $orderIds) {
    amountToPay
    approved
    canPay
    orderId
    pendingAmount
    receivedAmount
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query CustomerOrderPaymentOverlays($orderIds: [ID!]!) {\n  customerOrderPaymentOverlays(orderIds: $orderIds) {\n    amountToPay\n    approved\n    canPay\n    orderId\n    pendingAmount\n    receivedAmount\n  }\n}",
  "variables": {
    "orderIds": [
      "id"
    ]
  }
}
EOF

Variables:

{
  "orderIds": [
    "id"
  ]
}

Response:

{
  "data": {
    "customerOrderPaymentOverlays": [
      {
        "amountToPay": 0,
        "approved": true,
        "canPay": true,
        "orderId": "id",
        "pendingAmount": 0,
        "receivedAmount": 0
      }
    ]
  }
}

customerOrderPaymentOverlays(
  orderIds: [ID!]!
): [CustomerOrderPaymentOverlay!]!

Arguments

customerOrderPaymentOverlays.orderIds ● [ID!]! non-null scalar

The IDs of the orders.

Type

CustomerOrderPaymentOverlay object

"Payment under review" overlay for an order: AWAITING_PAYMENT + a pending COLLECTION payment (derived, never a backend status).