> For the complete documentation index, see [llms.txt](https://docs.iyzico.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.iyzico.com/urunler/mass-payout/mass-payout-toplu-odeme-entegrasyonu/toplu-odeme-raporlama.md).

# Toplu Ödeme Raporlama

## Toplu Ödeme Detayı Getir

> Toplu ödeme ve kırılım detaylarını döndürür.\
> requestId veya externalMassPayoutId alanlarından en az biri gönderilmelidir.<br>

```json
{"openapi":"3.0.3","info":{"title":"Toplu Ödeme (Mass Payout) API","version":"1.0.1"},"tags":[{"name":"Mass Payout","description":"Toplu ödeme işlemleri"}],"servers":[{"url":"https://api.iyzipay.com","description":"Canlı (Production)"},{"url":"https://sandbox-api.iyzipay.com","description":"Sandbox"}],"paths":{"/v1/mass/payout/retrieve":{"post":{"tags":["Mass Payout"],"summary":"Toplu Ödeme Detayı Getir","description":"Toplu ödeme ve kırılım detaylarını döndürür.\nrequestId veya externalMassPayoutId alanlarından en az biri gönderilmelidir.\n","parameters":[{"$ref":"#/components/parameters/AuthHeader"},{"$ref":"#/components/parameters/ContentTypeHeader"},{"$ref":"#/components/parameters/LocaleQuery"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MassPayoutRetrieveRequest"}}}},"responses":{"200":{"description":"Başarılı","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MassPayoutRetrieveResponse"}}}}}}}},"components":{"parameters":{"AuthHeader":{"name":"Authorization","in":"header","required":true,"description":"Authorization header, IYZWSv2 ile başlayan ve base64 formatında üretilmiş imzalı hash değeridir.","schema":{"type":"string"}},"ContentTypeHeader":{"name":"Content-Type","in":"header","required":true,"description":"İçerik tipi değeri.","schema":{"type":"string"}},"LocaleQuery":{"name":"locale","in":"query","required":true,"description":"Yanıt dili.","schema":{"type":"string","enum":["tr","en"]}}},"schemas":{"MassPayoutRetrieveRequest":{"type":"object","description":"requestId veya externalMassPayoutId alanlarından en az biri gönderilmelidir.","required":["itemType","page","size"],"properties":{"requestId":{"type":"string","description":"Toplu ödeme için korelasyon/takip kimliği. Init işleminin response'u üzerinde dönmektedir."},"externalMassPayoutId":{"type":"string","description":"Toplu ödeme isteği için benzersiz kimlik (idempotency)."},"itemType":{"type":"string","description":"Kırılım filtre tipi.","enum":["VALID","INVALID"]},"page":{"type":"integer","description":"Getirilecek sayfa numarası."},"size":{"type":"integer","description":"Sayfa başına sonuç adedi."}}},"MassPayoutRetrieveResponse":{"type":"object","description":"Toplu ödeme ve kırılım detayları yanıtı.","properties":{"status":{"type":"string","enum":["success","failure"]},"locale":{"type":"string"},"systemTime":{"type":"integer","description":"Sistem zamanı (epoch ms)."},"massPayout":{"$ref":"#/components/schemas/MassPayoutSummary"},"massPayoutItems":{"$ref":"#/components/schemas/MassPayoutItemsPage"},"page":{"type":"integer"},"size":{"type":"integer"},"total":{"type":"integer"}}},"MassPayoutSummary":{"type":"object","description":"Toplu ödeme özet bilgileri.","properties":{"externalId":{"type":"string"},"merchantId":{"type":"integer"},"totalAmount":{"type":"decimal"},"totalSuccessfulAmount":{"type":"decimal"},"massPayoutStatus":{"type":"string","description":"Toplu ödemenin yaşam döngüsü durumu (enum).","enum":["INIT","IN_PROGRESS","PUBLISHED_TO_QUEUE","COMPLETED","FAIL","INSUFFICIENT_BALANCE","CANCELED"]},"totalCommissionAmount":{"type":"decimal"},"currency":{"type":"string"}}},"MassPayoutItemsPage":{"type":"object","description":"Toplu ödeme kırılımlarının sayfalı listesi.","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/MassPayoutItemDetail"}}}},"MassPayoutItemDetail":{"type":"object","description":"Toplu ödeme kırılım detayı.","properties":{"itemExternalId":{"type":"string"},"referenceCode":{"type":"string"},"recipientType":{"type":"string","enum":["PHONE","IBAN","IDENTITY_NUMBER","MEMBER_ID"]},"recipientInfo":{"type":"string"},"recipientName":{"type":"string"},"description":{"type":"string"},"itemStatus":{"type":"string","description":"Toplu ödeme kırılımı statü durumu.","enum":["FAILED","SUCCESS","INIT","INVALID","PROCESSING","MASS_PAYOUT_CANCELED","QUEUED","DEPOSIT_SUCCESS","DEPOSIT_FAIL"]},"errorMessages":{"type":"array","items":{"type":"string"}},"totalAmount":{"type":"decimal"},"commissionAmount":{"type":"decimal"},"currencyCode":{"type":"string"}}}}}}
```

### Mass Payout Statü Durumları <a href="#masspayoutapidoc-masspayoutstatuslist" id="masspayoutapidoc-masspayoutstatuslist"></a>

<table data-full-width="true"><thead><tr><th>Status	</th><th>Description</th></tr></thead><tbody><tr><td>INIT</td><td>Toplu ödeme isteği alınmış ancak henüz yetkilendirilmemiştir.</td></tr><tr><td>IN_PROGRESS</td><td>İstek yetkilendirilmiş ve geçerli bir requestId ile devam ediyor (in progress) olarak işaretlenmiştir.</td></tr><tr><td>PUBLISHED_TO_QUEUE </td><td>İstek, iyzico’nun dahili kuyruğuna gönderilmiştir. En az bir ödeme bankaya iletilmiştir.</td></tr><tr><td>COMPLETED</td><td>Toplu ödeme ile ilişkili tüm öğeler başarıyla işlenmiştir.</td></tr><tr><td>FAIL</td><td>Toplu ödeme içindeki tüm öğeler banka tarafında başarısız olmuştur.</td></tr><tr><td>INSUFFICIENT_BALANCE</td><td>İsteğin gerçekleştirilebilmesi için üye işyerinin toplu ödeme bakiyesi yetersizdir.</td></tr><tr><td>CANCELED </td><td>Toplu ödeme isteği iptal edilmiştir.</td></tr></tbody></table>

### Mass Payout Kırılım Statü Durumları

<table data-full-width="true"><thead><tr><th>Status</th><th>Description</th></tr></thead><tbody><tr><td>FAILED</td><td>Öğe bankaya iletilmiş ancak başarısız olmuştur.<br>Bu durum, bankadan dönen hataları veya genel işlem hatalarını içerir.</td></tr><tr><td>SUCCESS</td><td>Öğe bankaya iletilmiş ve başarıyla tamamlanmıştır.</td></tr><tr><td>INIT</td><td>Toplu ödeme oluşturulduğunda, öğeler yetkilendirme (auth) işlemi öncesinde bekleme durumunda (waiting state) saklanır.</td></tr><tr><td>INVALID</td><td>Parametre(ler) geçersiz, eksik veya tutarsızdır.</td></tr><tr><td>PROCESSING</td><td>Öğe bankaya iletilmiş ve işlem devam etmektedir.</td></tr><tr><td>MASS_PAYOUT_CANCELED</td><td><p>Ana toplu ödeme iptal edildiği için ilgili kırılım da iptal edilmiştir.</p><p></p></td></tr><tr><td>QUEUED</td><td>İlgili kırılım kuyruğa alınmıştır (hem banka transferi hem de cüzdan/mevduat akışları için geçerlidir).</td></tr><tr><td>DEPOSIT_SUCCESS</td><td>Başarısız olan kırılım ve buna ait komisyon tutarı, üye işyerinin toplu ödeme bakiyesine başarıyla iade edilmiştir.</td></tr><tr><td>DEPOSIT_FAIL</td><td>Başarısız olan ödeme tutarı ve komisyon tutarı, toplu ödeme bakiyesine iade edilememiştir. </td></tr></tbody></table>

<br>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

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

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.iyzico.com/urunler/mass-payout/mass-payout-toplu-odeme-entegrasyonu/toplu-odeme-raporlama.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.