API Dokümantasyonu

Yespey API, işletmenizin ödeme süreçlerini programmatic olarak yönetmenizi sağlayan RESTful bir servistir. JSON tabanlı yanıtlar döndürür ve standart HTTP responce kodlarını kullanır.

Tüm API istekleri HTTPS üzerinden yapılmalıdır. HTTP üzerinden yapılan istekler reddedilecektir.

Kimlik Doğrulama

Yespey API, istekleri doğrulamak için API anahtarlarını kullanır. API anahtarlarınızı Dashboard üzerinden yönetebilirsiniz.

Bash

curl https://api.yespey.com/v1/payments \
  -u sk_live_XXXXXXXXXXXXXXXX:

Kimlik doğrulama için Basic Auth kullanılır. Kullanıcı adı olarak API anahtarınızı, şifre alanını ise boş bırakarak Base64 formatında header'a eklemeniz gerekir.

POST

/v1/payments

Yeni bir ödeme işlemi başlatmak için kullanılır.

Parametreler

Parametre	Tip	Zorunlu	Açıklama
amount	integer	Evet	Ödeme tutarı (Kuruş cinsinden)
currency	string	Evet	Para birimi kodu (örn: TRY, USD)
card_holder	object	Evet	Kart sahibi bilgileri

İstek Örneği

{
  "amount": 15000,
  "currency": "TRY",
  "payment_group": "PRODUCT",
  "conversation_id": "123456789",
  "callback_url": "https://site.com/callback",
  "buyer": {
    "id": "BY789",
    "name": "Ahmet",
    "surname": "Yılmaz",
    "email": "ahmet@email.com"
  }
}

Yanıt Örneği

{
  "status": "success",
  "locale": "tr",
  "systemTime": 1628594000,
  "conversationId": "123456789",
  "token": "token_x1y2z3...",
  "checkoutFormContent": "<script>...</script>",
  "pageUrl": "https://yespey.com/p/..."
}