List payments

List Payment records with cursor pagination. limit is a maximum: a page can hold fewer records while next_cursor is still set, so iterate until it is null. Filters on currency and amount match the record's own currency.

Query Parameters

entity
Type: stringnullable

External id of the entity to act for, from GET /v1/entities. Required when signed in with OAuth (an organization can hold several entities; ask the user which one if more than one could apply). Optional with an API key, which is scoped to one entity already.
external_ids
Type: array of string …100nullable

Exact external ids to return (repeat the key). At most 100.
currencies
Type: array of stringnullable

ISO 4217 codes (repeat the key). Matches the record's own currency, not the entity's functional currency.
platforms
Type: array of stringnullable

Source platforms the records were ingested from (e.g. stripe, ramp). Customer-inserted records carry the platform they declared, or api.
platform_object_ids
Type: array of stringnullable

The source platform's own ids for the records (e.g. a Stripe in_… id).
include_deleted
Type: boolean

Include records act has since deleted. They carry customFields.t0_deleted_at. Default false: deleted records are omitted.
cursor
Type: stringnullable

Opaque cursor from the previous page's next_cursor. Omit for the first page.
limit
Type: integer
min:
1
max:
200

Maximum records per page (1-200). A page can hold fewer while next_cursor is still set; iterate until it is null.
include_total
Type: boolean

Also return total, the number of matching records before the deleted overlay.
order
Type: "asc" or "desc"enum

Sort direction.
date_from
Type: stringFormat: datenullable

Inclusive lower bound on the record's date.
date_to
Type: stringFormat: datenullable

Inclusive upper bound on the record's date.
amount_min
nullable

Inclusive lower bound: decimal string, in the record's own currency, compared against amount. Requires exactly one value in currencies.
Type: number

Inclusive lower bound: decimal string, in the record's own currency, compared against amount. Requires exactly one value in currencies.
amount_max
nullable

Inclusive upper bound: decimal string, in the record's own currency, compared against amount. Requires exactly one value in currencies.
Type: number

Inclusive upper bound: decimal string, in the record's own currency, compared against amount. Requires exactly one value in currencies.
status
Type: array of "pending" or "failed" or "succeeded"enumnullable

Record statuses to include (repeat the key).
sort
Type: stringenum

Field to sort by. Amount sorts use each record's value in the entity's functional currency, so records in different currencies can look out of order; filter by one currency for a strict amount order.

values
datesucceededDateamountstatus
expand
Type: array of "customer" or "invoice"enumnullable

Linked records to include under expanded (repeat the key).

Responses

application/json
400

Amount filter without exactly one currency (CAPI64), a cursor that does not match the request's filters (CAPI65), or signed in with OAuth and no entity given (CAPI12).
401

The credential was refused: none sent (CAPI11), an API key that is not valid (CAPI15), or an OAuth sign-in that has expired (CAPI16), was not issued for this API (CAPI17), names an organization T0 does not hold (CAPI18) or a membership that is no longer usable (CAPI19). detail says what to do.
403

The key lacks customer_api:read, or the signed-in user cannot read this record type on the entity (CAPI71); or entity is not the key's own (CAPI14).
404

No such entity in your organization (CAPI13).
409

The entity has no applied books start date (CAPI67).
application/json

get/v1/payments

curl 'https://api.t0.ai/v1/payments?include_deleted=false&limit=50&include_total=false&order=desc&sort=date' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

Show Schema

{
  "data": [
    {
      "id": {
        "dataType": "Adjustment",
        "externalId": "string",
        "platformDataType": "string",
        "platformId": "string",
        "platformType": "string"
      },
      "data": {
        "amount": 1,
        "currencyCode": "string",
        "customFields": {
          "additionalProperty": "anything"
        },
        "date": "2026-11-11",
        "description": "string",
        "exchangeRates": [],
        "status": "pending",
        "succeededDate": "2026-11-11"
      },
      "links": [
        {
          "dataType": "Adjustment",
          "externalId": "string",
          "platformDataType": "string",
          "platformId": "string",
          "platformType": "string"
        }
      ],
      "expanded": {
        "additionalProperty": [
          {
            "data": {
              "amount": 1,
              "currencyCode": "string",
              "customFields": {
                "additionalProperty": "anything"
              },
              "date": "2026-11-11",
              "description": "string",
              "endDate": "2026-11-11",
              "exchangeRates": [],
              "startDate": "2026-11-11"
            },
            "id": {
              "dataType": "Adjustment",
              "externalId": "string",
              "platformDataType": "string",
              "platformId": "string",
              "platformType": "string"
            },
            "links": []
          }
        ]
      },
      "expanded_truncated": [
        "string"
      ]
    }
  ],
  "next_cursor": "string",
  "as_of": "2026-11-11T18:10:36.787Z",
  "total": 1
}

Successful Response

Get one Payment

Get one Customer