Debt Payments#

Debt Payments represent payments received from debtors toward collection cases. These are recorded by the collection partner as payments come in.

The Debt Payment object#

Attribute	Type	Description
`id`	string	Unique identifier with `dp_` prefix
`object`	string	Always `"debt_payment"`
`case`	string	Collection Case ID
`amount`	integer	Payment amount in smallest currency unit
`currency`	string	ISO 4217 currency code
`type`	enum	`full_payment`, `partial_payment`, `installment`
`payment_date`	timestamp	When the payment was received
`payout`	string	Your payout ID (after fee deduction)
`fee_amount`	integer	Collection fee deducted
`net_amount`	integer	Amount you receive
`created`	timestamp	Time at which the object was created

{
  "id": "dp_pay_001",
  "object": "debt_payment",
  "case": "dc_a1b2c3d4",
  "amount": 120000,
  "currency": "eur",
  "type": "installment",
  "payment_date": 1707436800,
  "payout": "po_debt_001",
  "fee_amount": 17400,
  "net_amount": 102600,
  "created": 1707436800
}

List Debt Payments#

GET /v1/debt_payments

Parameter	Type	Description
`case`	string	Filter by collection case
`created[gte]`	timestamp	Created on or after
`limit`	integer	Number of objects (1–100)

curl "https://api.casapay.com/v1/debt_payments?case=dc_a1b2c3d4" \
  -H "Authorization: Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc"

Retrieve a Debt Payment#

GET /v1/debt_payments/:id

curl https://api.casapay.com/v1/debt_payments/dp_pay_001 \
  -H "Authorization: Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc"