Sign in

v1

latestOpenAPI 3.0.2Apache License 2.02026-07-13109285691.8 KB
Payouts

Schedule a payout

Schedule a payout for auto-instruction in the future or update existing payout schedule if the payout has been scheduled before.

post/v3/payouts/{payoutId}/schedule

Path parameters

payoutIdstring uuid required

Id of the payout

Request body

scheduledForstring date-time required

UTC timestamp for instructing the payout. Format is ISO-8601.

notificationsEnabledboolean required

Flag to indicate whether to receive notifications when scheduled payout is processed

Example request

{
  "scheduledFor": "2025-01-01T10:00:00Z",
  "notificationsEnabled": true
}

Response

Payout is scheduled successfully