Mass Payout Initalize

Initialize Mass Payout

post

https://api.iyzipay.comhttps://sandbox-api.iyzipay.com

/v1/mass/payout/init

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)

Query parameters

localestring · enumRequired

Response language.

Possible values:

Header parameters

AuthorizationstringRequired

Authorization header; a signed hash value that starts with IYZWSv2 and is generated in Base64 format.

Example: IYZWSv2 aXBzaWduYXR1cmU...

Content-TypestringRequired

Content-Type value.

Example: application/json

Body

application/json

Mass payout initialization request.

externalIdstringRequired

Unique identifier for the mass payout request (idempotency).

Example: massPayoutId-323

conversationIdstringRequired

Correlation ID for the mass payout.

Example: conversationId-323

purposestring · enumOptional

Business purpose of the payout.

Example: GOODSPossible values:

Responses

200

Successful

application/json

post

/v1/mass/payout/init

HTTPcURL

POST /v1/mass/payout/init?locale=en HTTP/1.1
Host: api.iyzipay.com
Authorization: IYZWSv2 aXBzaWduYXR1cmU...
Content-Type: application/json

{
  "externalId": "massPayoutId-323ddd",
  "conversationId": "conversationId-323f",
  "purpose": "SALARY",
  "items": [
    {
      "itemExternalId": "ext-65656",
      "recipientType": "IBAN",
      "recipientInfo": "TR920086402100005482986178",
      "amount": { "value": 100, "currency": "TRY" },
      "description": "Payment for services",
      "recipientName": "John Doe"
    },
    {
      "itemExternalId": "ext-9545455",
      "recipientType": "MEMBER_ID",
      "recipientInfo": "2228853",
      "amount": { "value": 8000, "currency": "TRY" }
    },
    {
      "itemExternalId": "ext-545454542",
      "recipientType": "IDENTITY_NUMBER",
      "recipientInfo": "53857708216",
      "amount": { "value": 20000, "currency": "TRY" }
    },
    {
      "itemExternalId": "ext-50070945",
      "recipientType": "PHONE",
      "recipientInfo": "[phone]",
      "amount": { "value": 7000, "currency": "TRY" }
    }
  ]
}

200

Successful

{
  "status": "success",
  "systemTime": 1759231970716,
  "conversationId": "conversationId-894",
  "requestId": "179cdefc1-3ce6-4f51-bd09-c050274bd664"
}