Plan Oluştur

POST/partner/1.0/recurring/create

Gerekli scope: payment:saleIdempotency-Key zorunlu

Abonelik / otomatik ödeme planı kurar; tahsilatlar belirlenen periyotta otomatik denenir. Sonuçları orderNumber ile transaction/search üzerinden izlersiniz — bkz. Tekrarlayan Tahsilat.

Kart bazlı planda sağlayıcı token'ı gönderilmez: card/save ya da card/pay + saveCard: true ile sakladığınız kartın id değerini savedCardId olarak verirsiniz, token'ı sunucu kayıttan okur.

Kart token’ı dışarı çıkmaz

Plan yanıtı sağlayıcı kart token'ını ve iç cüzdan kimliklerini taşımaz. İhtiyacınız olan tek kart değeri, Kayıtlı Kart uçlarından dönen id'dir.

Örnek

curl -X POST https://<host>/partner/1.0/recurring/create \
  -H "X-Api-Key: ..." \
  -H "X-Timestamp: ..." \
  -H "X-Signature: ..." \
  -H "Idempotency-Key: create-SUB-1042" \
  -H "Content-Type: application/json" \
  -d '{
  "orderNumber": "SUB-1042",
  "amount": 149.9,
  "currency": "TRY",
  "description": "Aylık üyelik",
  "paymentMethod": "POS",
  "savedCardId": "8f2c1d5e-9a41-4c7b-b6a2-3f0e8d9c1a2b",
  "interval": "MONTH",
  "intervalValue": 1,
  "totalInstallmentCount": 12,
  "maxFailedRetries": 3,
  "startDate": "2026-09-01T00:00:00Z"
}'

İstek Body

Alan	Tip	Açıklama
`amount`zorunlu	decimal	Dönem başına tahsil edilecek tutar.
`startDate`zorunlu	date	İlk tahsilat tarihi.
`currency`	enum	Para birimi. Varsayılan: `TRY`
`paymentMethod`	enum	Ödeme yöntemi. Boş bırakılırsa POS (kart). Varsayılan: `POS` `POSWALLETLOYALTYCASHFREE`
`savedCardId`	string	Kayıtlı kart kimliği — card/save yanıtındaki `id`. Kart bazlı planlarda verilir.
`interval`	enum	Periyot birimi. Varsayılan: `MONTH` `DAYWEEKMONTHYEAR`
`intervalValue`	integer	Kaç periyotta bir. 1 = her ay. Varsayılan: `1`
`totalInstallmentCount`	integer	Toplam tahsilat adedi. 0 = süresiz. Varsayılan: `0`
`maxFailedRetries`	integer	Başarısız denemede kaç kez tekrar denenecek. Varsayılan: `3`
`expiryDate`	date	Planın biteceği tarih.
`description`	string	Abonenin ekstresinde görünecek açıklama.
`orderNumber`	string	Sizin kendi sipariş/sözleşme numaranız. Plandan doğan TÜM taksit tahsilatlarına taşınır; transaction/search ile tek numaradan hepsini listeleyebilirsiniz.
`reminderDaysBefore`	integer	Tahsilattan kaç gün önce hatırlatma gönderilir. Varsayılan: `3`
`enableEmailReminder`	boolean	E-posta hatırlatması. Varsayılan: `true`
`enableSmsReminder`	boolean	SMS hatırlatması. Varsayılan: `false`
`enablePushReminder`	boolean	Push hatırlatması. Varsayılan: `true`
`email`	string	Abone e-posta adresi.
`phoneCountryCode`	string	Abone telefon ülke kodu.
`phoneNumber`	string	Abone telefon numarası.

Yanıt

Alan	Anlamı
`id`	Plan kimliği. detail / update / pause / resume / cancel bu değeri alır.
`referenceNumber`	Sistem üretimli referans numarası.
`orderNumber`	Sizin gönderdiğiniz sipariş/sözleşme numaranız; plandan doğan tüm tahsilatlara taşınır.
`amount` / `currency`	Dönem başına tahsil edilecek tutar ve para birimi.
`description`	Abonenin ekstresinde görünecek açıklama.
`status`	Plan durumu (`ACTIVE`, `PAUSED`, `CANCELLED`, `COMPLETED`).
`interval` / `intervalValue`	Periyot birimi ve kaç periyotta bir çekileceği.
`totalInstallmentCount` / `paidInstallmentCount`	Toplam ve tahsil edilmiş dönem adedi.
`failedRetryCount`	Başarısız denemelerin sayacı.
`email` / `phoneCountryCode` / `phoneNumber`	Abone iletişim bilgileri.
`startDate` / `expiryDate`	İlk tahsilat ve plan bitiş tarihi.
`nextPaymentDate` / `lastPaymentDate`	Sıradaki ve son tahsilat tarihi.
`createdDate`	Planın kurulma tarihi.

Örnek yanıt (content)

{
  "id": "REC-3301",
  "referenceNumber": "CREC-3301",
  "orderNumber": "SUB-1042",
  "amount": 149.9,
  "currency": "TRY",
  "description": "Aylık üyelik",
  "status": "ACTIVE",
  "interval": "MONTH",
  "intervalValue": 1,
  "totalInstallmentCount": 12,
  "paidInstallmentCount": 0,
  "failedRetryCount": 0,
  "startDate": "2026-09-01T00:00:00Z",
  "nextPaymentDate": "2026-09-01T00:00:00Z",
  "lastPaymentDate": null,
  "createdDate": "2026-08-17T10:15:30.000Z"
}

İsteği Dene

Önizleme modu — değerler kod örneklerini günceller, gerçek istek atılmaz.

Mock

amount*startDate*currencypaymentMethodsavedCardIdintervalintervalValuetotalInstallmentCountmaxFailedRetriesexpiryDatedescriptionorderNumberreminderDaysBeforeenableEmailReminderenableSmsReminderenablePushReminderemailphoneCountryCodephoneNumber