Payout Schedules#

Payout Schedules define automatic payout rules. Configure daily, weekly, or monthly disbursements to landlord bank accounts.

The Payout Schedule object#

Attribute	Type	Description
`id`	string	Unique identifier with `ps_` prefix
`object`	string	Always `"payout_schedule"`
`interval`	enum	`daily`, `weekly`, `monthly`, `manual`
`weekly_anchor`	string	Day of week for weekly payouts (e.g., `monday`)
`monthly_anchor`	integer	Day of month for monthly payouts (1–28)
`destination`	string	Bank Account ID
`currency`	string	Payout currency
`minimum_amount`	integer	Minimum amount to trigger payout
`active`	boolean	Whether schedule is active
`metadata`	hash	Key-value pairs
`created`	timestamp	Time at which the object was created

{
  "id": "ps_weekly",
  "object": "payout_schedule",
  "interval": "weekly",
  "weekly_anchor": "friday",
  "destination": "ba_abc123",
  "currency": "gbp",
  "minimum_amount": 10000,
  "active": true,
  "created": 1706140800
}

Create, Retrieve, Update, Delete, List#

POST /v1/payout_schedules

GET /v1/payout_schedules/:id

POST /v1/payout_schedules/:id

DELETE /v1/payout_schedules/:id

GET /v1/payout_schedules

curl https://api.casapay.com/v1/payout_schedules \
  -H "Authorization: Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc" \
  -H "Content-Type: application/json" \
  -d '{
    "interval": "weekly",
    "weekly_anchor": "friday",
    "destination": "ba_abc123",
    "currency": "gbp",
    "minimum_amount": 10000
  }'