AlmondTill/G3N API

On this page

payments

query · in the family Payment

What it does

The payment list — each entry is a payment on an order.

The caller's org-group family's ACTIVE LISTING of Payments — doomed records DROP from listings. PAGINATED: limit clamps to [1, 200], default 100; nextToken = the prior page's cursor, verbatim — opaque + tenant-bound (a malformed or foreign token → VALIDATION/INVALID). Walk until nextToken is null (a page may hold fewer than limit — doomed drop per page). STRUCTURED FILTER + SORT: filter = AND across clauses, OR within a clause's values; sort = one declared field, asc/desc. The declared Payment roster: caption (text) · status (enum) · parentId (ref) · organizationId (ref) · currency (text) · amountMinor (money) · tipMinor (money) · brand (text) · last4 (text) · createdAt (date) · updatedAt (date). An illegal filter/sort refuses VALIDATION/INVALID NAMING the exact problem (an unknown field teaches the roster). A filtered/sorted read evaluates the WHOLE family server-side, returns the EXACT matchCount, and its nextToken binds to THE ONE filter+sort that minted it — replaying it under a different filter/sort refuses. Absent both, the unfiltered lane is unchanged (matchCount null).

What happens

Reads only — changes nothing.

Who may call it

Capability area: Reading your records — Looking up and listing the records of your organization.

Arguments

NameTypeRequiredNotes
filterFilterInputnoWhich records to answer — clauses over the family’s filterable fields (the FilterInput type and the paging guide carry the grammar).
sortSortInputnoThe order to answer in — one declared field and a direction (the SortInput type carries the grammar).
limitIntnoHow many records to answer at most; a page may hold fewer.
nextTokenStringnoThe cursor from the previous page, passed back exactly as received.

Returns

PaymentPage PaymentPage! — One page of the payments listing — the records + the opaque resume cursor.

This is a page: items holds the records and nextToken the cursor for the next page — pass it back verbatim until it is null. See paging.

Example request

query ExamplePayments($filter: FilterInput) {
  payments(filter: $filter) {
    items {
      id
      sysId
      type
      caption
      status
      parentId
      rootId
      createdAt
      updatedAt
      revisionNum
      revision
      organizationId
      amountMinor
      tipMinor
      currency
      methodRef
      tenderId
      stripeAccountRef
      sagaId
      intentRef
      chargeRef
      brand
      last4
      declineReason
    }
    nextToken
    matchCount
  }
}

Variables:

{
  "filter": {
    "clauses": [
      {
        "field": "caption",
        "op": "contains",
        "values": [
          "Blue"
        ]
      }
    ]
  }
}

Example response

{
  "data": {
    "payments": {
      "items": [
        {
          "id": "01900000-0000-7000-8000-37386ae00000",
          "sysId": "PY-EXMP-0000-000F",
          "type": "Payment",
          "caption": "Blue jeans",
          "status": "created",
          "parentId": "01900000-0000-7000-8000-065235280000",
          "rootId": "01900000-0000-7000-8000-a093dd800000",
          "createdAt": "2027-01-31T00:00:00.000Z",
          "updatedAt": "2027-01-31T00:00:00.000Z",
          "revisionNum": 1,
          "revision": "01900000-0000-7000-8000-b7960e180000",
          "organizationId": "01900000-0000-7000-8000-44b781470000",
          "amountMinor": 1,
          "tipMinor": 1,
          "currency": "USD",
          "methodRef": "<method ref>",
          "tenderId": "01900000-0000-7000-8000-0ae1978a0000",
          "stripeAccountRef": "<stripe account ref>",
          "sagaId": "01900000-0000-7000-8000-8b3fa5540000",
          "intentRef": "01900000-0000-7000-8000-0cb528b40000",
          "chargeRef": "01900000-0000-7000-8000-ae314a160000",
          "brand": "<brand>",
          "last4": "<last4>",
          "declineReason": "<decline reason>"
        }
      ],
      "nextToken": "<the cursor from the previous page>",
      "matchCount": 1
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": null,
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer