vellTRDocs

Müşteriler

Müşteri kayıtlarını ve kayıtlı kart tokenlarını yönetin; PAN'a dokunmadan kayıtlı kartlardan çekim yapın.

9 endpoints
POST/v1/customersRecommended

Bir müşteri kaydı oluşturur. externalId, üye işyeri başına benzersizdir.

İstek Parametreleri

AdTürZorunluAçıklama
externalIdstringZorunluYour own unique id for this customer
emailstringİsteğe BağlıCustomer email (unique per merchant when set)
phonestringİsteğe BağlıCustomer phone (+90…)
namestringİsteğe BağlıCustomer name
extraDataobjectİsteğe BağlıArbitrary merchant metadata
JSONİstek Örneği
{
  "externalId": "CUST-4821",
  "email": "buyer@example.com",
  "phone": "+905551112233",
  "name": "Ayşe Yılmaz"
}
JSONYanıt Örneği
{
  "id": "cus_a1b2c3d4e5f6",
  "merchantId": "mrc_8a1b2c3d4e5f",
  "externalId": "CUST-4821",
  "email": "buyer@example.com",
  "phone": "+905551112233",
  "name": "Ayşe Yılmaz",
  "extraData": {},
  "createdAt": "2026-04-13T10:00:00Z",
  "updatedAt": "2026-04-13T10:00:00Z"
}
GET/v1/customers/{id}Recommended

Bir müşteriyi kimliğine göre getirir.

JSONYanıt Örneği
{
  "id": "cus_a1b2c3d4e5f6",
  "merchantId": "mrc_8a1b2c3d4e5f",
  "externalId": "CUST-4821",
  "email": "buyer@example.com",
  "phone": "+905551112233",
  "name": "Ayşe Yılmaz",
  "extraData": {},
  "createdAt": "2026-04-13T10:00:00Z",
  "updatedAt": "2026-04-13T10:00:00Z"
}
PUT/v1/customers/{id}Optional

Bir müşteriyi günceller. Yalnızca gönderdiğiniz alanlar değiştirilir.

İstek Parametreleri

AdTürZorunluAçıklama
emailstringİsteğe BağlıNew email
phonestringİsteğe BağlıNew phone
namestringİsteğe BağlıNew name
extraDataobjectİsteğe BağlıReplace metadata
JSONİstek Örneği
{
  "name": "Ayşe Y. Demir"
}
JSONYanıt Örneği
{
  "id": "cus_a1b2c3d4e5f6",
  "merchantId": "mrc_8a1b2c3d4e5f",
  "externalId": "CUST-4821",
  "email": "buyer@example.com",
  "phone": "+905551112233",
  "name": "Ayşe Y. Demir",
  "extraData": {},
  "createdAt": "2026-04-13T10:00:00Z",
  "updatedAt": "2026-04-13T11:30:00Z"
}
GET/v1/customersRecommended

Keyset sayfalama ve isteğe bağlı e-posta/telefon filtreleriyle müşterileri listeler.

İstek Parametreleri

AdTürZorunluAçıklama
emailstringİsteğe BağlıFilter by email
phonestringİsteğe BağlıFilter by phone
limitintegerİsteğe BağlıPage size
cursorstringİsteğe BağlıOpaque keyset cursor from a prior page
JSONYanıt Örneği
{
  "items": [
    {
      "id": "cus_a1b2c3d4e5f6",
      "externalId": "CUST-4821",
      "email": "buyer@example.com",
      "name": "Ayşe Yılmaz",
      "createdAt": "2026-04-13T10:00:00Z"
    }
  ],
  "nextCursor": "eyJjcmVhdGVkQXQiOiIyMDI2LTA0LTEzVDEwOjAwOjAwWiJ9"
}
DELETE/v1/customers/{id}Optional

Bir müşteriyi soft-delete (yumuşak silme) ile kaldırır. 204 No Content döner.

JSONYanıt Örneği
{}
POST/v1/customers/{id}/cardsRecommended

Sonraki kayıtlı kart çekimleri için bir vault token'ını müşteriye bağlar. Token, aynı işlem içinde card-vault'ta müşteriye bağlanır.

İstek Parametreleri

AdTürZorunluAçıklama
cardTokenstringZorunluVault token (tok_…) to attach
isDefaultbooleanİsteğe BağlıMake this the customer default card
JSONİstek Örneği
{
  "cardToken": "tok_9f8e7d6c5b4a",
  "isDefault": true
}
JSONYanıt Örneği
{
  "id": "cuc_2b3c4d5e6f70",
  "customerId": "cus_a1b2c3d4e5f6",
  "cardToken": "tok_9f8e7d6c5b4a",
  "last4": "4321",
  "bin": "415565",
  "brand": "visa",
  "expMonth": 12,
  "expYear": 2028,
  "isDefault": true,
  "createdAt": "2026-04-13T10:05:00Z"
}
GET/v1/customers/{id}/cardsRecommended

Bir müşterinin kayıtlı kart token'larını listeler (yalnızca referanslar, asla PAN içermez).

JSONYanıt Örneği
{
  "items": [
    {
      "id": "cuc_2b3c4d5e6f70",
      "customerId": "cus_a1b2c3d4e5f6",
      "cardToken": "tok_9f8e7d6c5b4a",
      "last4": "4321",
      "brand": "visa",
      "expMonth": 12,
      "expYear": 2028,
      "isDefault": true,
      "createdAt": "2026-04-13T10:05:00Z"
    }
  ]
}
GET/v1/customers/{id}/cards/defaultOptional

Müşterinin varsayılan kayıtlı kartını döndürür. Müşterinin varsayılan kartı yoksa 404 döner.

JSONYanıt Örneği
{
  "cardToken": "tok_9f8e7d6c5b4a",
  "customerId": "cus_a1b2c3d4e5f6",
  "last4": "4321",
  "brand": "visa",
  "expMonth": 12,
  "expYear": 2028
}
DELETE/v1/customers/{id}/cards/{cardId}Recommended

Kayıtlı bir kartı kaldırır ve card-vault'taki token'ını iptal eder. 204 No Content döner.

JSONYanıt Örneği
{}

Kategori Özeti

Toplam Endpoint

9

Ana Domain

api.pay.kvell.group