GitHubFeedback FormAPI Reference - Beta

Toplu Ödeme Sorgulama

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

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

Bir toplu ödeme içinde yer alan tek bir kırılımın ayrıntılarını getirir.

Path parameters
referenceCodestringRequired

Toplu ödeme kırılımının sistem tarafından atanmış benzersiz referans kodu.

Example: b9a2f39c-0403-4869-a23a-371046c7431f
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
Responses
200

Başarılı

application/json
get
/v1/mass/payout/retrieve/items/{referenceCode}
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

Başarılı

{
  "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 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.

Last updated