API Reference

Payments

Payment/transaction endpoints

Manage payments (transactions) for deals.

List Payments

GET /api/public/v1/deals/:dealId/payments

Parameter	Type	Description
page	number	Page number
limit	number	Items per page (max: 100)
type	string	Filter by type
status	string	Filter by status

Required Scope: payments:read

Get Payment

GET /api/public/v1/deals/:dealId/payments/:transactionId

Required Scope: payments:read

Create Payment

POST /api/public/v1/deals/:dealId/payments

Required Scope: payments:write

{
  "amount": 500.00,
  "type": "merchantPayment",
  "effectiveDate": "2026-03-04",
  "notes": "Regular daily payment"
}