> For the complete documentation index, see [llms.txt](https://docs.shortcutco.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.shortcutco.com/developers/api-reference/reference/objects/payment.md).

# The payment object

The payment object in the Shortcut API - every field, an example, and the endpoints that return it.

A payment against an invoice.

## Fields

| Field            | Type                                      | Description                                                                                                                                                                                                                                                                                                   |
| ---------------- | ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id`             | id                                        | The payment's id.                                                                                                                                                                                                                                                                                             |
| `object`         | `"payment"`                               | Always `payment`.                                                                                                                                                                                                                                                                                             |
| `invoiceId`      | id                                        | The invoice the payment applies to.                                                                                                                                                                                                                                                                           |
| `customerId`     | id                                        | The customer who paid.                                                                                                                                                                                                                                                                                        |
| `amount`         | number                                    | Amount paid, in US dollars.                                                                                                                                                                                                                                                                                   |
| `method`         | `online`, `cash`, `check`, `ach`, `other` | `online` when the customer paid through Shortcut (card or bank). Otherwise how the workspace recorded an offline payment: `cash`, `check`, `ach` (a bank transfer made outside Shortcut), or `other`.                                                                                                         |
| `reference`      | string or null                            | The reference recorded with an offline payment, such as a check number.                                                                                                                                                                                                                                       |
| `refundedAmount` | number                                    | Total of the refunds against this payment that have succeeded as of this request, in US dollars; 0 when none. A refund can succeed later without changing the payment or its invoice, so `createdSince` and `updatedSince` syncs do not pick up refund changes; read the payment again for the current total. |
| `paidAt`         | timestamp                                 | When the payment was made, ISO 8601 in UTC.                                                                                                                                                                                                                                                                   |
| `createdAt`      | timestamp                                 | When the payment was recorded, ISO 8601 in UTC.                                                                                                                                                                                                                                                               |

## Example

```json
{
  "id": "20104d3b-1c5a-4882-88a4-c3c914eeff10",
  "object": "payment",
  "invoiceId": "2da479a2-29ee-44e9-8638-f03022832b77",
  "customerId": "e8d9f013-e524-4b5a-816e-66a1ddb8a1e8",
  "amount": 129.5,
  "method": "online",
  "reference": "Check 2204",
  "refundedAmount": 0,
  "paidAt": "2026-10-16T17:04:12.381Z",
  "createdAt": "2026-10-16T17:04:12.381Z"
}
```

## Endpoints

| Endpoint                          | What it does              |
| --------------------------------- | ------------------------- |
| `POST /v1/invoices/{id}/payments` | Record an offline payment |
| `GET /v1/payments`                | List payments             |
| `GET /v1/payments/{id}`           | Get a payment             |