vellTRDocs

Para Transferleri

FAST veya EFT ile TR IBAN'larına, OCT ile kartlara ödeme gönderin. Kullanılabilir bakiyeleri sorgulayın ve toplu ödeme taslakları çalıştırın.

9 endpoints
POST/v1/payoutsOptional

Bir TR IBAN'ına (rail "fast" veya "eft") ya da token yönlendirmesiyle bir karta (rail "card") transfer gönderir. payable_now kontrolünü çalıştırır, defteri kilitler ve sağlayıcıya iletir. status "pending" olarak döner; nihai durum payout.* webhook'u üzerinden gelir. İsteğe bağlı bir Idempotency-Key başlığını destekler.

İstek Parametreleri

AdTürZorunluAçıklama
storeIdstringZorunluStore the payout draws from
railstringZorunlu"fast" | "eft" | "card"
ibanstringZorunluDestination TR IBAN (validated mod-97; empty for card rail)
holderNamestringZorunluAccount holder name
amountMinorintegerZorunluAmount in kuruş
currencystringZorunluAlways "TRY"
clientReferencestringİsteğe BağlıMerchant pass-through reference
JSONİstek Örneği
{
  "storeId": "sto_5a6b7c8d",
  "rail": "fast",
  "iban": "TR330006100519786457841326",
  "holderName": "Acme Ltd",
  "amountMinor": 100000,
  "currency": "TRY"
}
JSONYanıt Örneği
{
  "payoutId": "7c8d9e0f-1a2b-3c4d-5e6f-708192a3b4c5",
  "status": "pending"
}
GET/v1/payoutsOptional

Keyset sayfalama ile para transferlerini listeler. Filtreler: storeId, status (virgülle ayrılmış).

İstek Parametreleri

AdTürZorunluAçıklama
storeIdstringİsteğe BağlıFilter by store
statusstringİsteğe BağlıComma-separated status filter
limitintegerİsteğe BağlıPage size
cursorstringİsteğe BağlıOpaque keyset cursor
JSONYanıt Örneği
{
  "payouts": [
    {
      "payoutId": "7c8d9e0f-1a2b-3c4d-5e6f-708192a3b4c5",
      "status": "succeeded",
      "rail": "fast",
      "amountMinor": 100000,
      "currency": "TRY",
      "createdAt": "2026-04-13T10:00:00Z",
      "resolvedAt": "2026-04-13T10:00:04Z"
    }
  ],
  "nextCursor": "eyJjcmVhdGVkQXQiOiIyMDI2LTA0LTEzVDEwOjAwOjAwWiJ9"
}
GET/v1/payouts/{id}Optional

Bir para transferini kimliğine göre getirir.

JSONYanıt Örneği
{
  "payoutId": "7c8d9e0f-1a2b-3c4d-5e6f-708192a3b4c5",
  "status": "succeeded",
  "merchantId": "mrc_8a1b2c3d4e5f",
  "storeId": "sto_5a6b7c8d",
  "rail": "fast",
  "iban": "TR330006100519786457841326",
  "holderName": "Acme Ltd",
  "amountMinor": 100000,
  "currency": "TRY",
  "providerRef": "fast_9a2e6b4d",
  "createdAt": "2026-04-13T10:00:00Z",
  "submittedAt": "2026-04-13T10:00:01Z",
  "resolvedAt": "2026-04-13T10:00:04Z"
}
POST/v1/payouts/{id}/cancelOptional

Hâlâ iptal edilebilir durumdaki bir para transferini iptal eder (created / kilit öncesi funds_locked). Gerektiğinde ters defter kaydını oluşturur.

JSONİstek Örneği
{}
JSONYanıt Örneği
{
  "payoutId": "7c8d9e0f-1a2b-3c4d-5e6f-708192a3b4c5",
  "status": "cancelled",
  "resolvedAt": "2026-04-13T10:00:02Z"
}
GET/v1/payouts/outstandingOptional

payable_now hesaplamasında kullanılan, devam eden (henüz sonuçlanmamış) para transferlerinin toplam tutarı.

JSONYanıt Örneği
{
  "merchantId": "mrc_8a1b2c3d4e5f",
  "pendingMinor": 250000,
  "currency": "TRY"
}
POST/v1/payout-draftsOptional

İncelenmek üzere bir grup planlanan para transferi yükler. Her satır yapısal olarak doğrulanır. Taslağı onaylamak, geçerli her satırı gerçek bir para transferine dönüştürür. En fazla 1000 satır; taslak başına bir mağaza. dest = IBAN (fast/eft) veya kart token'ı (card); bu değer hiçbir zaman yanıtta geri döndürülmez.

İstek Parametreleri

AdTürZorunluAçıklama
storeIdstringZorunluStore all rows draw from
rowsarrayZorunlu[{rail, dest, holderName, amountMinor, currency}]
JSONİstek Örneği
{
  "storeId": "sto_5a6b7c8d",
  "rows": [
    {
      "rail": "fast",
      "dest": "TR330006100519786457841326",
      "holderName": "Acme Ltd",
      "amountMinor": 100000,
      "currency": "TRY"
    },
    {
      "rail": "eft",
      "dest": "TR120006200119000006672315",
      "holderName": "Beta AŞ",
      "amountMinor": 50000,
      "currency": "TRY"
    }
  ]
}
JSONYanıt Örneği
{
  "draftId": "drf_8192a3b4c5d6",
  "status": "draft",
  "rowCount": 2,
  "validCount": 2,
  "invalidCount": 0,
  "createdAt": "2026-04-13T10:00:00Z"
}
GET/v1/payout-drafts/{id}Optional

Taslak başlığı ve satır bazında işlem sonucu.

JSONYanıt Örneği
{
  "draftId": "drf_8192a3b4c5d6",
  "status": "draft",
  "rows": [
    {
      "rowId": "row_01",
      "rail": "fast",
      "holderName": "Acme Ltd",
      "amountMinor": 100000,
      "status": "validated"
    },
    {
      "rowId": "row_02",
      "rail": "eft",
      "holderName": "Beta AŞ",
      "amountMinor": 50000,
      "status": "validated"
    }
  ]
}
POST/v1/payout-drafts/{id}/approveOptional

Bir taslağı onaylar; arka planda çalışan dağıtım süreci, doğrulanan her satırı gerçek bir para transferine dönüştürür (satır başına en fazla bir transfer).

JSONİstek Örneği
{}
JSONYanıt Örneği
{
  "draftId": "drf_8192a3b4c5d6",
  "status": "approved"
}
POST/v1/payout-drafts/{id}/cancelOptional

Dağıtım başlamadan önce bir taslağı iptal eder.

JSONİstek Örneği
{}
JSONYanıt Örneği
{
  "draftId": "drf_8192a3b4c5d6",
  "status": "cancelled"
}

Kategori Özeti

Toplam Endpoint

9

Ana Domain

api.pay.kvell.group