Mass Payout Cancel

Cancel Mass Payout

post

Cancels the mass payout request and its items that are in INIT status.

Path parameters

requestIdstringRequired

Correlation / tracking identifier of the mass payout.

Example: 79cdefc1-3ce6-4f51-bdd9-c050274db664

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

Responses

200

Successful

application/json

post

HTTPcURL

POST /v1/mass/payout/cancel/79cdefc1-3ce6-4f51-bdd9-c050274db664?locale=en HTTP/1.1
Host: api.iyzipay.com
Authorization: IYZWSv2 aXBzaWduYXR1cmU...
Content-Type: application/json

200

Successful

{
  "status": "success",
  "systemTime": 1759231995145
}