Sign in

v1

latestOpenAPI 3.0.32026-07-2476126451.9 KB
v1.1

Create bulk payout request

Create a bulk payout request

post/api/v1.4/payout/bulk/requests/

Request body

labelstring required

A label for the bulk payout request

webhook_urlstring uri required

Webhook URL to be called for bulk payout events

Response

idstring required
labelstring nullable

Label for the bulk payout request

source'API' | 'DASHBOARD' | 'SANDBOX_TEST_DATA' | '' | 'null' nullable
  • API - API
  • DASHBOARD - DASHBOARD
  • SANDBOX_TEST_DATA - SANDBOX_TEST_DATA
statusstring nullable
webhook_urlstring uri nullable

Webhook URL to be called for bulk payout events

parsing_validation_errors_file_urlstring
is_liveboolean
items_countinteger
validation_pending_items_countinteger required
scheduled_items_countinteger required
validation_failed_items_countinteger required
cancelled_items_countinteger required
intent_created_items_countinteger required
intent_creation_failed_items_countinteger required
createdstring date-time required
completed_atstring date-time nullable
cancelled_atstring date-time nullable
pending_file_upload_atstring date-time nullable
pending_file_parsing_atstring date-time nullable
file_parsing_failed_atstring date-time nullable
active_atstring date-time nullable