Mark a dividend as paid

PATCH https://app.speybooks.com/api/v1/dividends/{id}/pay

Marks a declared dividend as paid and creates the payment journal: debit Dividends Payable, credit Bank. The payment date defaults to today if not specified.

Path parameters

id string required

Dividend ID (e.g. div_1). Must use the dividend prefix.

Body parameters

paidDate string optional

Payment date (YYYY-MM-DD). Defaults to today if omitted.

pattern: ^\d{4}-\d{2}-\d{2}$

Response

200 Dividend marked as paid. Returns the updated dividend with payment journal details.

Show response fields

paid boolean

transactionId string

Error codes

400 Dividend is already paid or voided.

404 Dividend not found.

Request PATCH /v1/dividends/{id}/pay curl

curl -X PATCH https://api.speybooks.com/v1/dividends/div_5/pay \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{ "paymentDate": "2026-02-20" }'

Response 200

{
  "success": true,
  "data": {
    "paid": true,
    "transactionId": "txn_95"
  }
}