Abonelik oluşturma
Abonelik, ortak ödeme sayfası başlatma isteğinde paymentGroup alanı SUBSCRIPTION gönderilerek oluşturulur. İlk ödeme 3D Secure olarak tamamlandıktan sonra sonraki tahsilatlar plana göre gerçekleştirilir.
| HTTP metodu |
URL |
POST |
/payment/v1/checkout-payments/init |
Plan alanları
| Alan |
Tip |
Zorunlu |
Açıklama |
externalCustomerId |
string |
Hayır |
Üye işyerindeki müşteri kimliği. En fazla 255 karakter. |
planCode |
string |
Hayır |
Üye işyerindeki plan kodu. En fazla 50 karakter. |
periodType |
integer |
Evet |
Tahsilat dönemi: 7 (hafta), 30 (ay) veya 365 (yıl). |
price |
decimal |
Koşullu |
Sabit dönem tutarı. Pozitif olmalıdır. |
nochargeDayCount |
integer |
Evet |
İlk tahsilattan önceki ücretsiz gün sayısı. Varsayılan 0. |
description |
string |
Evet |
Abonelik açıklaması. |
paymentCount |
integer |
Hayır |
Planın toplam tahsilat dönemi sayısı. |
variablePayment |
boolean |
Hayır |
Değişken tutarlı plan olup olmadığını belirtir. |
variablePaymentTriggerType |
string |
Koşullu |
Değişken plan tetikleme tipi: SCHEDULED veya EXTERNAL. |
paymentSteps |
array |
Hayır |
Dönem bazlı fiyat ve ödeme tarihi adımları. |
Ödeme adımı alanları
| Alan |
Tip |
Zorunlu |
Açıklama |
startPeriod |
integer |
Evet |
Adımın başlayacağı dönem. En az 1. |
periodPrice |
decimal |
Evet |
Dönem tutarı. 0 değerinden büyük olmalıdır. |
paymentDate |
date |
Evet |
Tahsilat tarihi (YYYY-MM-DD). |
skipPaymentPeriod |
boolean |
Hayır |
İlgili dönemin tahsilatsız geçileceğini belirtir. |
Örnek istek
{
"price": 99.90,
"paidPrice": 99.90,
"currency": "TRY",
"paymentGroup": "SUBSCRIPTION",
"callbackUrl": "https://merchant.example.com/payment/callback",
"conversationId": "order-2026-001",
"items": [
{ "name": "Premium üyelik", "price": 99.90 }
],
"plan": {
"externalCustomerId": "customer-42",
"planCode": "PREMIUM-MONTHLY",
"periodType": 30,
"price": 99.90,
"nochargeDayCount": 0,
"description": "Aylık premium üyelik",
"paymentCount": 12,
"variablePayment": false
}
}
Başarılı isteğin response alanları Ödeme Sayfası bölümünde açıklanmıştır. Abonelik kimliği, ilk ödeme başarıyla tamamlandığında oluşturulur.
Abonelik durumları
| Değer |
Sayısal değer |
Açıklama |
ACTIVE |
0 |
Abonelik aktif. |
PASSIVE |
1 |
Abonelik durdurulmuş. |
PENDING |
2 |
İlk veya sıradaki işlem bekleniyor. |
DELETED |
3 |
Abonelik silinmiş. |
PROCESSING |
4 |
Tahsilat işleniyor. |
ANOMALY |
5 |
Ödeme ile abonelik güncellemesi arasında tutarsızlık oluşmuş. |
WAITING |
6 |
Sonraki tahsilat denemesi bekleniyor. |