# Mass Payout Initalize

## Initialize Mass Payout

> Creates a new \*\*Mass Payout\*\*. Each valid payout item is stored with status \`INIT\`.\
> \
> \*\*Resulting States\*\*\
> \- Mass Payout → \`INIT\`\
> \- Mass Payout Items → \`INIT\` (if valid) or \`INVALID\` (if invalid)<br>

```json
{"openapi":"3.0.3","info":{"title":"Mass Payout API","version":"1.0.0"},"tags":[{"name":"Mass Payout","description":"Mass payout operations"}],"servers":[{"url":"https://api.iyzipay.com","description":"Production"},{"url":"https://sandbox-api.iyzipay.com","description":"Sandbox"}],"paths":{"/v1/mass/payout/init":{"post":{"tags":["Mass Payout"],"summary":"Initialize Mass Payout","description":"Creates a new **Mass Payout**. Each valid payout item is stored with status `INIT`.\n\n**Resulting States**\n- Mass Payout → `INIT`\n- Mass Payout Items → `INIT` (if valid) or `INVALID` (if invalid)\n","parameters":[{"$ref":"#/components/parameters/AuthHeader"},{"$ref":"#/components/parameters/ContentTypeHeader"},{"$ref":"#/components/parameters/LocaleQuery"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MassPayoutInitializeRequest"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MassPayoutInitializeResponse"}}}}}}}},"components":{"parameters":{"AuthHeader":{"name":"Authorization","in":"header","required":true,"description":"Authorization header; a signed hash value that starts with **IYZWSv2** and is generated in Base64 format.","schema":{"type":"string"}},"ContentTypeHeader":{"name":"Content-Type","in":"header","required":true,"description":"Content-Type value.","schema":{"type":"string"}},"LocaleQuery":{"name":"locale","in":"query","required":true,"description":"Response language.","schema":{"type":"string","enum":["tr","en"]}}},"schemas":{"MassPayoutInitializeRequest":{"type":"object","description":"Mass payout initialization request.","required":["externalId","conversationId","items"],"properties":{"externalId":{"type":"string","description":"Unique identifier for the mass payout request (idempotency)."},"conversationId":{"type":"string","description":"Correlation ID for the mass payout."},"purpose":{"type":"string","description":"Business purpose of the payout.","enum":["SALARY","BONUS","SETTLEMENT","GOODS","SERVICES","CASHBACK","REBATES","DONATIONS"]},"items":{"type":"array","description":"Payout items.","minItems":1,"items":{"$ref":"#/components/schemas/MassPayoutItem"}}}},"MassPayoutItem":{"type":"object","description":"Mass payout item.","required":["itemExternalId","recipientType","recipientInfo","amount","description"],"properties":{"itemExternalId":{"type":"string","description":"ID per payout item."},"recipientType":{"type":"string","description":"Type of recipient identifier.","enum":["PHONE","IBAN","IDENTITY_NUMBER","MEMBER_ID"]},"recipientInfo":{"type":"string","description":"Identifier matching the recipientType (phone, IBAN, etc.)."},"amount":{"$ref":"#/components/schemas/Amount"},"description":{"type":"string","description":"Item description."},"recipientName":{"type":"string","description":"Recipient name. **Required if** `recipientType` is `IBAN`."},"nonWithdrawable":{"type":"boolean","description":"iyzico ensures that the fee sent to your wallet cannot be withdrawn."}}},"Amount":{"type":"object","description":"Amount information.","required":["value","currency"],"properties":{"value":{"type":"decimal","description":"Amount to send."},"currency":{"type":"string","description":"Currency code."}}},"MassPayoutInitializeResponse":{"type":"object","description":"Mass payout initialization response.","properties":{"requestId":{"type":"string","description":"Correlation / tracking identifier for the mass payout."},"conversationId":{"type":"string","description":"Correlation ID inherited from the base request if present."},"status":{"type":"string","enum":["success","failure"]},"locale":{"type":"string","description":"Language/region setting such as `tr` or `en`."},"systemTime":{"type":"integer","description":"System time (epoch ms)."},"invalidItems":{"type":"array","description":"Collection of order-level error details.","items":{"$ref":"#/components/schemas/InvalidItem"}}}},"InvalidItem":{"type":"object","description":"Invalid payout item detail.","properties":{"externalId":{"type":"string","description":"External ID of the specific item that failed."},"errorCode":{"type":"string"},"errorMessage":{"type":"string"}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.iyzico.com/en/products/mass-payout/mass-payout-integration/mass-payout-initalize.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.