---
title: "Create bulk payout request"
method: POST
path: "/api/v1.4/payout/bulk/requests/"
tags: ["v1.1"]
---

# Create bulk payout request

`POST /api/v1.4/payout/bulk/requests/`

Create a bulk payout request

## Request body

- BulkPayoutRequest
  - `label` string, required — A label for the bulk payout request
  - `webhook_url` string, uri, required — Webhook URL to be called for bulk payout events
  - `items` BulkPayoutRequestItem[], required — Items to be included in the bulk payout request
    - `merchant_reference` string, required — Unique reference for the item
    - `scheduled_date` string, date, required — Scheduled date for the payout intent to be processed, using the format 'YYYY-MM-DD'
    - `payout_intent_details` unknown, required

## Response `201`

- BulkPayoutRequestDetail
  - `id` string, required
  - `label` string, 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
  - `status` string, nullable
  - `webhook_url` string, uri, nullable — Webhook URL to be called for bulk payout events
  - `parsing_validation_errors_file_url` string
  - `is_live` boolean
  - `items_count` integer
  - `validation_pending_items_count` integer, required
  - `scheduled_items_count` integer, required
  - `validation_failed_items_count` integer, required
  - `cancelled_items_count` integer, required
  - `intent_created_items_count` integer, required
  - `intent_creation_failed_items_count` integer, required
  - `created` string, date-time, required
  - `completed_at` string, date-time, nullable
  - `cancelled_at` string, date-time, nullable
  - `pending_file_upload_at` string, date-time, nullable
  - `pending_file_parsing_at` string, date-time, nullable
  - `file_parsing_failed_at` string, date-time, nullable
  - `active_at` string, date-time, nullable

## Other responses

- `400`
- `401`

---

[API](https://skmtc.net/moneyhash/apis/moneyhash-api.md) · [All operations](https://skmtc.net/moneyhash/apis/moneyhash-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/moneyhash/moneyhash-api/versions/111e4c2e0826/schema)