Entegrasyon
APIPay
Genel Bilgiler

APIPay

Hepsipay checkout deneyimi ve avantajları her yerde!

Test Urlhttps://merchantpfpayment-gateway-qa.hepsipay.com/apipay (opens in a new tab)
Test Health Checkhttps://merchantpfpayment-gateway-qa.hepsipay.com/health-check (opens in a new tab)
Prod Urlhttps://merchantpfpayment-gateway.hepsipay.com/apipay (opens in a new tab)
Prod Health Checkhttps://merchantpfpayment-gateway.hepsipay.com/health-check (opens in a new tab)

Important!

  • Gateway'i consume edebilmek için MerchantNo, TerminalNo ve StoreKey bilgilerini talep etmelisiniz.
  • Signature gerektiren requestlerde header da merchant-no terminal-no ve signature alanları gönderilmelidir
  • Tüm requestlerde finansal değer içeren tüm Amount alanları için son 2 hane ondalıklı kısmı temsil edecek şekilde,orjinal tutarın 100 ile çarpılmasıyla elde edilen INTEGER değer beklenecektir.
    • Tüm responselarımızda Amount(Tutar) değerleri için aynı kuralı işletip değerleri 100 ile çarparak response bilgisi dönüyor olacağız.
      • Örnek 1: 100,50 TL (100 lira 50 kuruş) tutarındaki bir işlem için, 100,50 * 100 = 10050(int) göndermelisiniz.
      • Örnek 2: 500 TL (500 lira) tutarındaki bir işlem için 500 * 100 = 50000(int) göndermelisiniz.
      • Örnek 3: 0,5 TL (50 kuruş) tutarındaki bir işlem için 0,5 * 100 = 50(int) göndermelisiniz.

Response Description

401 http status code(unauthorized) response veren isteklerde Response Base bilgisi dönülmemektedir.

401 alınacak durumlar

  • İstek yapılan operasyona yetkinizin olmaması
  • Signature uyuşmazlıklarında
  • Header bilgisinde ilgili alanların gönderilmemesinde

401 http status hata kodu almayan diğer tüm Api isteklerinde aşağıdaki ResponseBase model bilgisi dönecektir. İstekte bulunulan request'e ait response bilgisi harici "Description" kolonunda açıklanmıştır.

OutputNameTypeDescription
Successboolİsteğin başarılı olma durumunda true, aksi durumda false döner.
MessageCodestringİstek başarılı ise "0000" değil ise bir hata kodu döner.
MessagestringResponse ile ilgili teknik mesaj.
UserMessagestringKullanıcıya gösterilebilecek mesaj.
UserMessageTitlestringKullanıcıya gösterilebilecek mesaj başlığı.

Sequence Diagram

apipay