v1

latestOpenAPI 3.0.02026-07-24102143224.1 KB

Payments

List payments

get/v3/payments

Query parameters

pagenumber required

Page Number

limitnumber required

Number of items to return

filterstring

Format: field:rule:value — comma-separated for multiple filters.

Fields: receivedAt (datetime): eq, neq, gt, gte, lt, lte status (string): eq, neq, like, nlike, in, nin, isnull, isnotnull type (string): eq, neq, like, nlike, in, nin, isnull, isnotnull invoiceId (uuid): eq, neq, in, nin, isnull, isnotnull customerId (uuid): eq, neq, in, nin, isnull, isnotnull

Date-only values (YYYY-MM-DD) match the full UTC day.

Example: filter=receivedAt:gte:2026-01-01

Response

Get all Payments by filter

successboolean required

Boolean with true=success, false=failure

messagestring required

Plain-text description of the result

Example response

{
  "payload": {
    "data": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "invoiceId": "123e4567-e89b-12d3-a456-426614174000",
        "total": 99.99,
        "stripeId": "pi_1234567890",
        "receivedAt": "2023-01-01T00:00:00.000Z",
        "status": "COMPLETED",
        "type": "MANUAL",
        "reference": "REF123456",
        "method": "CREDIT_CARD",
        "externalIds": [
          {
            "id": "pi_1234567890"
          }
        ]
      }
    ]
  }
}