Ana içeriğe geç

retrieve-saved-cards

POST /api/{team}/gateway/retrieve-saved-cards

Kayıtlı kartları döndürür; hiçbir şeyi değiştirmez. Bir müşterinin bütün kartlarını onun referansıyla sorarsınız; varsayılan kart önce, diğerleri eskiden yeniye gelir. Her kart, saklandığı müşterinin referansını taşır.

Kimlik doğrulama​

X-Api-Key, X-Timestamp, X-Signature, Content-Type: application/json. Ayrıntılar: Kimlik Doğrulama ve İmza.

İstek​

Kayıt üç yoldan biriyle adlandırılır; en fazla biri gönderilir:

{ "token": "3b7e1f20-5c4a-4d8e-9f1b-7a6c5d4e3f21" }
{ "customer_reference": "musteri-88" }
{ "created_from": "2026-09-26", "created_to": "2026-10-02" }
AlanTipZorunluAçıklama
tokenstring (UUID)hayırKaydın token'ı. customer_reference ya da tarih aralığıyla birlikte gönderilmez.
customer_referencestringhayırMüşterinin sizdeki referansı; o müşterinin bütün kartları döner. Tarih aralığıyla birlikte gönderilmez.
created_fromstringhayırBaşlangıç günü, YYYY-MM-DD. created_to ile birlikte gönderilir.
created_tostringhayırBitiş günü, YYYY-MM-DD. created_from ile birlikte gönderilir; ondan önce olamaz. Aralık iki gün dahil en fazla 7 gündür.

Tarihler çalışma alanının saat dilimindedir. Hiçbir alan gönderilmezse ({}) bugün dahil son 7 gün listelenir. Yanıt her zaman bir listedir; eşleşen kayıt yoksa liste boştur. Başka bir çalışma alanının kaydı hiçbir zaman dönmez.

SDK örnekleri​

not

Örneklerdeki $client / client nesnesinin kurulumu: İstemciyi Kurmak.

use Gurmehub\Odemehub\Request\RetrieveSavedCards;

$cards = $client->retrieveSavedCards(RetrieveSavedCards::byReference('musteri-88'));

$cards->default(); // varsayılan kart, varsa
$cards->savedCards[0]->customer?->reference;

Yanıt​

{
"result": { "successful": true, "message": null },
"saved_cards": [
{
"token": "2d4f6a8c-0e1b-4c3d-9f5e-7a9b1c3d5e6f",
"payment_provider_token": "8e0a2c4b-6d1f-4e3a-b5c7-9d1e3f5a7b2c",
"holder_name": "AHMET YILMAZ",
"scheme": "mastercard",
"first_digits": "54003600",
"last_four_digit": "0003",
"expiry_month": "12",
"expiry_year": "2030",
"is_default": true,
"created_at": "2026-10-02T09:40:00.000000Z",
"customer": { "reference": "musteri-88" }
}
]
}
AlanTipAçıklama
created_from, created_tostringYalnızca tarih aralığıyla (ya da boş gövdeyle) sorulduğunda: listenin kapsadığı günler.
saved_cards[]arrayKart nesneleri, her biri customer alanıyla. Müşteri referansıyla sorulduğunda varsayılan kart önce gelir.

Kart nesnesi​

Kayıtlı kart uçlarında ve ödeme yanıtlarındaki saved_card alanında aynı nesne döner. Kart numarasının tamamı ve güvenlik kodu hiçbir yanıtta yer almaz.

AlanTipAçıklama
tokenstringKartın token'ı. Ödemede transaction.saved_card_token olarak gönderilir.
payment_provider_tokenstringKartın saklandığı ödeme hesabı. Kayıtlı kartla ödeme bu hesaptan alınır.
holder_namestringKart sahibinin adı.
schemestring | nullvisa, mastercard, american_express, troy, discover, diners_club, jcb, unionpay, maestro.
first_digitsstringKart numarasının ilk 6 ya da 8 hanesi.
last_four_digitstringKart numarasının son 4 hanesi.
expiry_monthstring"01"–"12".
expiry_yearstring4 hane.
is_defaultbooleanMüşterinin varsayılan kartıysa true. Müşterinin en son ödeme yaptığı ya da en son saklanan kart varsayılan olur; abonelik dönemleri varsayılan karttan çekilir.
created_atstringISO 8601 UTC.

Bu listede her kart, saklandığı müşteriyi customer.reference olarak taşır. Diğer kart uçlarının yanıtında customer kartın yanında, üst seviyede döner ve yalnızca reference taşır.

HTTP durum kodları​

KodDurum
200Liste döndü; eşleşen kayıt yoksa boş.
401API anahtarı ya da imza geçersiz.
403Çalışma alanı işlem yapamıyor, planı kayıtlı kartları kapsamıyor ya da Kayıtlı Kartlar modülü kapalı.
422Doğrulama hatası.
429İstek sınırı aşıldı.

Hatalar​

AlanMesaj
tokenToken ile birlikte referans ya da tarih aralığı gönderilmez.
customer_referenceReferans ile birlikte tarih aralığı gönderilmez.
created_toBitiş tarihi başlangıç tarihinden önce olamaz. / Tarih aralığı en fazla 7 gün olabilir.