Mass Payout Initalize
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) orINVALID
(if invalid)
Query parameters
localestring · enumRequiredPossible values:
Response language.
Header parameters
AuthorizationstringRequiredExample:
Authorization header; a signed hash value that starts with IYZWSv2 and is generated in Base64 format.
IYZWSv2 aXBzaWduYXR1cmU...
Content-TypestringRequiredExample:
Content-Type value.
application/json
Body
Mass payout initialization request.
externalIdstringRequiredExample:
Unique identifier for the mass payout request (idempotency).
massPayoutId-323
conversationIdstringRequiredExample:
Correlation ID for the mass payout.
conversationId-323
purposestring · enumOptionalExample:
Business purpose of the payout.
GOODS
Possible values: Responses
200
Successful
application/json
post
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": "+905456856931",
"amount": { "value": 7000, "currency": "TRY" }
}
]
}
200
Successful
{
"status": "success",
"systemTime": 1759231970716,
"conversationId": "conversationId-894",
"requestId": "179cdefc1-3ce6-4f51-bd09-c050274bd664"
}
Last updated