Ana içeriğe geç

Kaptan Partner API

Kaptan Partner API, entegratörlerin Kaptan ödeme motorunu dış dünyadan güvenli biçimde çağırabilmesi için HMAC imzalı bir veri düzlemi sunar.

Genel Bakış

  • Base URL: https://<host>/partner/1.0/... — tüm çağrılar POST + JSON.
  • Kimlik Doğrulama: Per-request HMAC-SHA256 imzası. Üç header: X-Api-Key, X-Timestamp, X-Signature. Detay için bkz. Kimlik Doğrulama.
  • Entegrasyon anahtarı: Entegrasyonlar merchant panelinden oluşturulur. Oluşturma anında bir API anahtarı (ok_live_ / ok_test_), bir secret (yalnızca bir kez gösterilir) ve bir dizi scope üretilir.
  • Scope: Her endpoint bir scope gerektirir. Bkz. Scope Kataloğu.
  • Sandbox: ok_test_ önekli anahtarlar sandbox ortamına yönlenir; ödemeler gerçek bankalara gitmez. Bkz. Test Kartları.

Kapsam

GrupUç noktalar
POSKart ödemesi, BIN sorgu, taksit listeleme, işlem arama/detay, iptal, iade
Ödeme LinkiTahsilat linki oluşturma
QRKarekod oluşturma

İşletme Kapsamı

İşlemler, API anahtarınızın tanımlı olduğu işletme kapsamında gerçekleşir. İstek gövdesinde ayrıca bir işletme bilgisi göndermenize gerek yoktur; kapsam API anahtarınızdan belirlenir.

Hızlı Başlangıç

curl -X POST https://<host>/partner/1.0/pos/card/pay \
-H "X-Api-Key: ..." \
-H "X-Timestamp: ..." \
-H "X-Signature: ..." \
-H "Content-Type: application/json" \
-d '{
"referenceCode": "ORD-1001",
"paymentMethod": "CARD",
"amount": 100.00,
"currency": "TRY",
"cardNumber": "5406681122223338",
"cardHolderName": "Test User",
"expMonth": 12,
"expYear": 2030,
"cvv": "000"
}'