vellTRDocs

Abonelik Oluştur

POST/v1/subscriptionsOptional

Yinelenen bir abonelik oluşturur. cardToken isteğe bağlıdır — belirtilmezse müşterinin varsayılan kayıtlı kartı kullanılır. İsteğe bağlı bir Idempotency-Key başlığını destekler.

Kimlik Doğrulama

İmza Deseni

HMAC-SHA256(secretKey, "{timestamp}\nPOST\n/v1/subscriptions\n{sha256(body)}")
BaşlıkDeğerAçıklama
X-Api-Keypk_live_a1b2c3d4e5f6g7h8Merchant public API key
X-Signature{hmac_sha256_hex}Hex HMAC-SHA256 request signature
X-Timestamp2026-04-13T10:00:00ZISO 8601 UTC request time (±5 min)

İstek Parametreleri

AdTürZorunluAçıklama
storeIdstringZorunluStore the subscription belongs to
customerIdstringZorunluCustomer being billed
amountMinorintegerZorunluPer-cycle amount in kuruş
currencystringZorunluAlways "TRY"
intervalCountintegerZorunluNumber of interval units per cycle
intervalUnitstringZorunluday|week|month|year
cardTokenstringİsteğe BağlıSaved card token (defaults to the customer default card)
trialEndAtstringİsteğe BağlıISO 8601 — start trialing until this date
generateInvoicesbooleanİsteğe BağlıGenerate an invoice each renewal
descriptionstringİsteğe BağlıSubscription description

İstek Örneği

JSONİstek Gövdesi
{
  "storeId": "sto_5a6b7c8d",
  "customerId": "cus_a1b2c3d4e5f6",
  "amountMinor": 50000,
  "currency": "TRY",
  "intervalCount": 1,
  "intervalUnit": "month"
}

Yanıt Parametreleri

AlanTürÖrnek
idstring"sub_5e6f70819a2b"
merchantIdstring"mrc_8a1b2c3d4e5f"
storeIdstring"sto_5a6b7c8d"
customerIdstring"cus_a1b2c3d4e5f6"
publicHashstring"kQ7rS1tV5wY8zaB3xK9mN2"
statusstring"active"
amountMinorinteger50000
currencystring"TRY"
intervalCountinteger1
intervalUnitstring"month"
cycleNumberinteger0
nextChargeAtstring"2026-05-13T10:00:00Z"
cardLast4string"4321"
cardBrandstring"visa"
createdAtstring"2026-04-13T10:00:00Z"

Yanıt Örneği

JSONYanıt
{
  "id": "sub_5e6f70819a2b",
  "merchantId": "mrc_8a1b2c3d4e5f",
  "storeId": "sto_5a6b7c8d",
  "customerId": "cus_a1b2c3d4e5f6",
  "publicHash": "kQ7rS1tV5wY8zaB3xK9mN2",
  "status": "active",
  "amountMinor": 50000,
  "currency": "TRY",
  "intervalCount": 1,
  "intervalUnit": "month",
  "cycleNumber": 0,
  "nextChargeAt": "2026-05-13T10:00:00Z",
  "cardLast4": "4321",
  "cardBrand": "visa",
  "createdAt": "2026-04-13T10:00:00Z"
}

Durum Kodları

200Success
201Created
400Bad Request
401Unauthorized
404Not Found
429Rate Limited
DeneSahte
POSThttps://api.pay.sandbox.kvell.group