For the complete documentation index, see llms.txt. This page is also available as Markdown.

Toplu Ödeme Başlatma

Toplu Ödeme Başlat

post
/v1/mass/payout/init

Yeni bir toplu ödeme oluşturur. Geçerli kırılımlar INIT durumunda saklanır.

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
Body

Toplu ödeme başlatma isteği.

externalIdstringRequired

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

Example: massPayoutId-323
conversationIdstringOptional

Toplu ödeme için korelasyon ID'si.

Example: conversationId-323
purposestring · enumOptional

Ödemenin iş amacı.

Example: GOODSPossible values:
Responses
200

Başarılı

application/json

Toplu ödeme başlatma yanıtı.

requestIdstringOptional

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

conversationIdstringOptional

Varsa temel istekteki korelasyon kimliği.

statusstring · enumOptionalPossible values:
localestringOptional

Yanıt dili (tr veya en).

systemTimeintegerOptional

Sistem zamanı (epoch ms).

post/v1/mass/payout/init
POST /v1/mass/payout/init?locale=tr HTTP/1.1
Host: api.iyzipay.com
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 307

{
  "externalId": "massPayoutId-323ddd",
  "conversationId": "conversationId-323f",
  "purpose": "SALARY",
  "items": [
    {
      "itemExternalId": "ext-65656",
      "recipientType": "IBAN",
      "recipientInfo": "TR920086402100005482986178",
      "amount": {
        "value": 100,
        "currency": "TRY"
      },
      "description": "Payment for services",
      "recipientName": "John Doe"
    }
  ]
}
{
  "status": "success",
  "locale": "tr",
  "systemTime": 1759231970716,
  "conversationId": "conversationId-894",
  "requestId": "179cdefc1-3ce6-4f51-bd09-c050274bd664"
}

Last updated