Skip to main content
GET
/
payments
/
{id}
Get a payment
curl --request GET \
  --url https://www.ruddr.io/api/workspace/payments/{id} \
  --header 'Authorization: Bearer <token>'
{
  "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",
  "paymentMethod": {
    "id": "a7f3c2e1-5b84-4d09-8e6a-1c9d0b7f4e52",
    "name": "Wire Transfer"
  },
  "client": {
    "id": "6d4b9e27-3c15-4f8a-b0e2-7a5c8d1f9043",
    "name": "Acme Corp"
  },
  "invoices": [
    {
      "id": "b2e8f461-7d30-4c9a-8f15-5e2b0c7d3a96",
      "number": "INV-001",
      "amount": 52500
    }
  ]
}
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.

Path Parameters

​
id
string
required

The payment uuid.

Response

200

​
id
string

The unique identifier for the object.

​
referenceNumber
string | null

The payment reference number (e.g., a check number or wire transfer ID).

​
receivedOn
string<date>

The date the payment was received (YYYY-MM-DD).

​
notes
string | null

Additional notes about the payment.

​
currency
string

The 3-letter ISO 4217 currency code for the payment.

​
amount
number

The total payment amount.

​
createdAt
string<date-time>

The timestamp when the object was created.

​
paymentMethod
object

The payment method used for this payment.

​
client
object

The client associated with this payment.

​
invoices
object[]

The invoices this payment is applied to.