Skip to main content
GET
/
payments
List payments
curl --request GET \
  --url https://www.ruddr.io/api/workspace/payments \
  --header 'Authorization: Bearer <token>'
{
  "results": [
    {
      "id": "3e7c1f92-8a45-4b6d-9e0f-2c4d8b1a5e73",
      "referenceNumber": "WIRE-20250115",
      "receivedOn": "2025-01-15",
      "notes": "Payment received via wire transfer.",
      "currency": "USD",
      "amount": 52500,
      "createdAt": "2025-01-15T20:47:03.284Z",
      "client": {
        "id": "6d4b9e27-3c15-4f8a-b0e2-7a5c8d1f9043",
        "name": "Acme Corp"
      },
      "paymentMethod": {
        "id": "a7f3c2e1-5b84-4d09-8e6a-1c9d0b7f4e52",
        "name": "Wire Transfer"
      },
      "invoices": [
        {
          "id": "b2e8f461-7d30-4c9a-8f15-5e2b0c7d3a96",
          "number": "INV-001",
          "amount": 52500
        }
      ]
    }
  ],
  "hasMore": false
}
A client’s payment towards one or more invoices.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
startingAfter
string

A cursor ID (uuid) used to request the next page of results. If not provided, defaults to the first page of results.

​
endingBefore
string

A cursor ID (uuid) used to request the previous page of results. Is mutually exclusive with startingAfter.

​
limit
integer

The maximum number of results to be returned. Can be any number from 1 to 100. Defaults to 10, if not provided.

​
clientId
string

A client ID (uuid) used to filter payments for a specific client.

Response

200

​
results
object[]

The list of results for the current page.

​
hasMore
boolean

Whether there are more results available after this page.