Skip to main content
GET
Get a payment
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.

client
object

The client associated with this payment.

paymentMethod
object | null

The payment method used for this payment.

invoices
object[]

The invoices this payment is applied to.