customerPayments

Requires a customer (portal or buyer app) session.

Customer portal: lists the signed-in customer's own payments, paged. Draft, cancelled, reversed, refunded and awaiting-approval payments are not shown. Needs a customer (portal or buyer app) session.

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 CustomerPayments {
  customerPayments {
    items {
      id
      paymentNumber
      referenceNumber
      status
      createdAt
      amount
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query CustomerPayments {\n  customerPayments {\n    items {\n      id\n      paymentNumber\n      referenceNumber\n      status\n      createdAt\n      amount\n    }\n  }\n}"
}
EOF

Response:

{
  "data": {
    "customerPayments": {
      "items": [
        {
          "id": "id",
          "paymentNumber": "string",
          "referenceNumber": "string",
          "status": "string",
          "createdAt": "2025-01-15T00:00:00Z",
          "amount": 0
        }
      ]
    }
  }
}

customerPayments(
  filter: CustomerPaginationInput
): CustomerPaymentConnection!

Arguments

customerPayments.filter ● CustomerPaginationInput input

Which page to return, and optional search text.

Type

CustomerPaymentConnection object

A page of payments.