Payout Items#

Payout Items detail the individual transactions that make up a payout. Each item links back to the original charge or payment.

The Payout Item object#

AttributeTypeDescription
idstringUnique identifier with poi_ prefix
objectstringAlways "payout_item"
payoutstringParent Payout ID
typeenumcharge, refund, adjustment, fee
amountintegerItem amount
currencystringISO 4217 currency code
sourcestringSource object ID (charge, refund, etc.)
descriptionstringItem description
createdtimestampTime at which the object was created
{
  "id": "poi_item1",
  "object": "payout_item",
  "payout": "po_xyz789",
  "type": "charge",
  "amount": 120000,
  "currency": "gbp",
  "source": "ch_abc123",
  "description": "Rent payment — Unit 4B",
  "created": 1706140800
}

List Payout Items#

GET /v1/payout_items

ParameterTypeDescription
payoutstringFilter by payout
curl "https://api.casapay.com/v1/payout_items?payout=po_xyz789" \
  -H "Authorization: Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc"