GitHubFeedback FormAPI Reference - Beta

Toplu Ödeme Başlatma

Toplu Ödeme Başlat (Initialize Mass Payout)

post

Yeni bir Toplu Ödeme oluşturur. Doğrulaması başarılı olan her ödeme kırılımı INIT durumunda saklanır.

Oluşan Durumlar

  • Toplu Ödeme → INIT

  • Toplu Ödeme Kırılımları → INIT (geçerliyse) veya INVALID (geçersizse)

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

Toplu ödeme başlatma isteği.

externalIdstringRequired

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

Example: massPayoutId-323
conversationIdstringRequired

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
post
POST /v1/mass/payout/init?locale=en HTTP/1.1
Host: api.iyzipay.com
Authorization: IYZWSv2 aXBzaWduYXR1cmU...
Content-Type: application/json

{
  "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"
    },
    {
      "itemExternalId": "ext-9545455",
      "recipientType": "MEMBER_ID",
      "recipientInfo": "2228853",
      "amount": { "value": 8000, "currency": "TRY" }
    },
    {
      "itemExternalId": "ext-545454542",
      "recipientType": "IDENTITY_NUMBER",
      "recipientInfo": "53857708216",
      "amount": { "value": 20000, "currency": "TRY" }
    },
    {
      "itemExternalId": "ext-50070945",
      "recipientType": "PHONE",
      "recipientInfo": "+905456856931",
      "amount": { "value": 7000, "currency": "TRY" }
    }
  ]
}
200

Başarılı

{
  "status": "success",
  "systemTime": 1759231970716,
  "conversationId": "conversationId-894",
  "requestId": "179cdefc1-3ce6-4f51-bd09-c050274bd664"
}

Last updated