VEvelopaymentsapi
Payouts

Schedule a payout

Changed on

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

Request

  • Base URL
    https://api.sandbox.velopayments.com
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://api.sandbox.velopayments.com/v1/login

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

Changes