Toplu Ödeme Raporlama

Toplu Ödeme ve Kırılım Detayı Getir

post

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

/v1/mass/payout/retrieve

Bir Toplu Ödeme ve içindeki ödeme kırılımlarının ayrıntılarını döndürür. Sayfalama parametreleri ile birlikte requestId ya da externalMassPayoutId (veya her ikisini) sağlamanız gerekir.

Query parameters

localestring · enumRequired

Yanıt dili.

Possible values:

Header parameters

AuthorizationstringRequired

Yetkilendirme başlığı; IYZWSv2 ile başlayan ve Base64 formatında üretilen imzalı özet değeri.

Example: IYZWSv2 aXBzaWduYXR1cmU...

Content-TypestringRequired

İçerik tipi değeri.

Example: application/json

Body

application/json

Toplu ödeme ve kırılım detaylarını sorgulama isteği.

requestIdstringOptional

Toplu ödeme için korelasyon / takip kimliği.

Example: c95e344a-c7c9-4605-91b8-3f48ee9dece6

externalMassPayoutIdstringOptional

Toplu ödeme isteği için benzersiz kimlik (idempotency).

Example: massPayoutId-323

pageintegerRequired

Getirilecek sayfa numarası.

Example: 0

sizeintegerRequired

Sayfa başına sonuç adedi.

Example: 40

Responses

200

Başarılı

application/json

post

/v1/mass/payout/retrieve

HTTPcURL

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

{
  "requestId": "c95e344a-c7c9-4605-91b8-3f48ee9dece6",
  "externalMassPayoutId": "massPayoutId-323",
  "page": 0,
  "size": 40
}

200

Başarılı

{
  "status": "success",
  "systemTime": 1759155442830,
  "massPayout": {
    "externalId": "massPayoutId-323",
    "merchantId": 1,
    "totalAmount": 201,
    "totalSuccessfulAmount": 0,
    "massPayoutStatus": "PUBLISHED_TO_QUEUE",
    "totalCommissionAmount": 0,
    "currency": "TRY"
  },
  "massPayoutItems": {
    "items": [
      {
        "itemExternalId": "ext-0077",
        "referenceCode": "a97b14a2-1e22-4ceb-bafb-38b61c4c4477",
        "recipientType": "IBAN",
        "recipientInfo": "TR920086402100005482986178",
        "recipientName": "Jane Customer",
        "description": "Payment for services",
        "itemStatus": "INIT",
        "errorMessages": [],
        "totalAmount": 100.5,
        "commissionAmount": 20,
        "currencyCode": "TRY"
      },
      {
        "itemExternalId": "ext-0099",
        "referenceCode": "05b8f881-aaf7-4004-8f0a-21bbed27a816",
        "recipientType": "IBAN",
        "recipientInfo": "TR920086402100005482986178",
        "recipientName": "Alice Example",
        "description": "Payment for services",
        "itemStatus": "INIT",
        "errorMessages": [],
        "totalAmount": 100.5,
        "commissionAmount": 20,
        "currencyCode": "TRY"
      }
    ]
  },
  "page": 0,
  "size": 40,
  "total": 2
}

Mass Payout Statü Durumları

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

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

Status	Description
FAILED	Öğe bankaya iletilmiş ancak başarısız olmuştur. Bu durum, bankadan dönen hataları veya genel işlem hatalarını içerir.
SUCCESS	Öğe bankaya iletilmiş ve başarıyla tamamlanmıştır.
INIT	Toplu ödeme oluşturulduğunda, öğeler yetkilendirme (auth) işlemi öncesinde bekleme durumunda (waiting state) saklanır.
INVALID	Parametre(ler) geçersiz, eksik veya tutarsızdır.
PROCESSING	Öğe bankaya iletilmiş ve işlem devam etmektedir.
MASS_PAYOUT_CANCELED	Ana toplu ödeme iptal edildiği için ilgili kırılım da iptal edilmiştir.
QUEUED	İ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).
DEPOSIT_SUCCESS	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.
DEPOSIT_FAIL	Başarısız olan ödeme tutarı ve komisyon tutarı, toplu ödeme bakiyesine iade edilememiştir.