Mass Payout Reporting

Retrieve Mass Payout Item Detail

get

Retrieves the details of an item contained within a mass payout.

Path parameters

referenceCodestringRequired

Unique reference code of the mass payout item.

Example: b9a2f39c-0403-4869-a23a-371046c7431f

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

get

HTTPcURL

GET /v1/mass/payout/retrieve/items/b9a2f39c-0403-4869-a23a-371046c7431f?locale=en HTTP/1.1
Host: api.iyzipay.com
Authorization: IYZWSv2 aXBzaWduYXR1cmU...
Content-Type: application/json

200

Successful

{
  "status": "success",
  "systemTime": 1759235562617,
  "item": {
    "itemExternalId": "ext-65656",
    "referenceCode": "b9a2f39c-0403-4869-a23a-371046c7431f",
    "recipientType": "IBAN",
    "recipientInfo": "TR920086402100005482986178",
    "recipientName": "Jane Customer",
    "description": "Payment for services",
    "itemStatus": "INIT",
    "errorMessages": [],
    "totalAmount": 100,
    "commissionAmount": 20,
    "currencyCode": "TRY"
  }
}

Mass Payout Item Status List

Status	Description
FAILED	Item was sent to the bank but failed. Includes errors returned from the bank or general processing errors. Validation errors will also result in this status.
SUCCESS	Item was sent to the bank and completed successfully.
INIT	When the mass payout is created, items are stored in waiting state before auth
INVALID	Parameter(s) are invalid, missing, or inconsistent.
PROCESSING	Item has been sent to the bank and is being processed.
MASS_PAYOUT_CANCELED	Item was canceled because the parent mass payout was canceled.
QUEUED	Item has been queued (for both bank transfer and wallet/deposit flows)
DEPOSIT_SUCCESS	Failed item and its commission amount were successfully refunded to the merchant mass payout balance
DEPOSIT_FAIL	Failed payment amount and commission amount could not be refunded to the mass payout balance. An error was returned.