Skip to content

Settlements

Base path: `/api/settlements`

Settlements are created automatically when debts are paid off or can be manually tracked.

Get Settlement

  • Method: `GET`
  • Endpoint: `/:settlementId`

Approve Settlement (Payee Only)

  • Method: `POST`
  • Endpoint: `/:settlementId/approve` Marks debt as settled.

Reject Settlement (Payee Only)

  • Method: `POST`
  • Endpoint: `/:settlementId/reject`
  • Body: `{"reason": "Did not receive money"}`

Upload Proof (Payer Only)

  • Method: `POST`
  • Endpoint: `/:settlementId/proof`
  • Body: FormData with proof file.