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#
| Attribute | Type | Description |
|---|---|---|
id | string | Unique identifier with poi_ prefix |
object | string | Always "payout_item" |
payout | string | Parent Payout ID |
type | enum | charge, refund, adjustment, fee |
amount | integer | Item amount |
currency | string | ISO 4217 currency code |
source | string | Source object ID (charge, refund, etc.) |
description | string | Item description |
created | timestamp | Time 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
| Parameter | Type | Description |
|---|---|---|
payout | string | Filter by payout |
curl "https://api.casapay.com/v1/payout_items?payout=po_xyz789" \
-H "Authorization: Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc"