Toplu Ödeme Sorgulama

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

get

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

/v1/mass/payout/retrieve/items/{referenceCode}

Belirtilen toplu ödeme kırılımına ait detay bilgilerini döndürür.

Path parameters

referenceCodestringRequired

Toplu ödeme kırılımına ait benzersiz referans kodu.

Query parameters

localestring · enumRequired

Yanıt dili.

Possible values:

Header parameters

AuthorizationstringRequired

Authorization header, IYZWSv2 ile başlayan ve base64 formatında üretilmiş imzalı hash değeridir.

Content-TypestringRequired

İçerik tipi değeri.

Example: application/json

Responses

200

Başarılı

application/json

Tekil toplu ödeme kırılımı detayı yanıtı.

statusstring · enumOptionalPossible values:

localestringOptional

Yanıt dili (tr veya en).

systemTimeintegerOptional

Sistem zamanı (epoch ms).

get/v1/mass/payout/retrieve/items/{referenceCode}

HTTPcURLJavaScriptPython

GET /v1/mass/payout/retrieve/items/{referenceCode}?locale=tr HTTP/1.1
Host: api.iyzipay.com
Authorization: text
Content-Type: application/json
Accept: */*

200

Başarılı

{
  "status": "success",
  "locale": "text",
  "systemTime": 1,
  "item": {
    "itemExternalId": "ext-0077",
    "referenceCode": "a97b14a2-1e22-4ceb-bafb-38b61c4c4477",
    "recipientType": "IBAN",
    "recipientInfo": "TR920086402100005482986178",
    "recipientName": "Jane Customer",
    "description": "Payment for services",
    "itemStatus": "INIT",
    "errorMessages": [
      "text"
    ],
    "totalAmount": 100.5,
    "commissionAmount": 20,
    "currencyCode": "TRY"
  }
}

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.