YKB Karekod Ödeme

Iframe üzerinden QR ile ödeme sırasında token alıp doğrulama yapan servistir.

Servise gönderilmesi gereken parametreler şu şekildedir:
Parametre ismi Tip Uzunluk Zorunluluk Örnek Değer Açıklama
memberId long 16 Evet 1 Her zaman 1
merchantId long 16 Evet 2 Sizin için oluşturulan Üye işyeri ID'si
customerId String 100 Hayır test@test.com Üye işyeri tarafında kayıtlı olan kullanıcının tekil bilgisidir. İster bir id ister bir email olabilir
userCode String 40 Evet test Kullanıcı kodu. Test olarak girilebilir.
txnType String 20 Evet Auth İşlem Tipi. Gönderilebilecek parametreler aşağıdadır: Auth --> Satış, PreAuth --> Ön Provizyon, PostAuth --> Provizyon kapama, Void --> İptal, Refund --> İade, Inquiry --> Ödeme sorgulama, QrAuth --> QR kod ile ödeme, PointAuth --> Puanlı Ödeme
installmentCount String 2 Hayır 1 Taksit sayısını ifade eder. İşlem taksitli işlem olacaksa bu sayı 1 den büyük olmalıdır. Eğer 1 den küçük veya numerik olmayan bir değer gönderilirse 0 kabul edilir.
currency String 3 Evet 949 Kur bilgisi. (TL:949, USD:840, EUR:978, GBP:826, JPY:392, RUB:643)
okUrl String 2048 Hayır https:/.... İşlem başarılı olduğunda üye işyerine dönülecek url bilgisi.
failUrl String 2048 Hayır https:/.... İşlem başarısız olduğunda üye işyerine dönülecek url bilgisi.
orderId String 2048 Hayır order1:/... Üye işyeri tarafından üretilen işleme özgü bir numaradır. Doldurulmaz ise sistem her işlem için kendisi de otomatik olarak bir sipariş numarası üretmektedir.
totalAmount String 19 Evet 9950 İşlem tutarı 9950 99 TL 50 kuruş demektir, virgül veya noktalama içermez küsürat için 2 hanedir. 1 TL için 100 gönderilmelidir.
rnd String 64 Evet abcd Hash hesaplamasında kullanılan random numaradır.
hash String 2048 Evet abcdefgh İşlemin güvenliği için oluşturulan hash bilgisidir.
paymentSystem String 2048 Hayır https:/.... İşlem ödeme sistemi bilgisi
description String 2048 Hayır - İşlem açıklama bilgisi.
Servisten dönen parametreler şu şekildedir:
Parametre ismi Tip Uzunluk Açıklama
token string 2048 Token bilgisi
merchantNo string 16 Üye işyeri numarası
terminalNo string 16 POS terminali numarası
merchantLogoUrl string 2048 Üye işyeri logo url bilgisi
techinalErrorReturnUrl string 2048 Teknik hata dönüş url bilgisi
url string 16 İşlem yapılan url bilgisi
responseCode string 16 İşlem cevap kodu
Örnek JSON formatında istek ve cevaplar aşağıdadır:

HTTP Method: POST

Content-Type: application/json

TEST URL: https://ppgpayment-test.birlesikodeme.com:20000/api/ppg/Payment/AuthenticationQrCodeFromIframe

PROD URL: https://{baseUrl}/api/ppg/Payment/AuthenticationQrCodeFromIframe

*Prod için baseUrl adresi, size entegrasyon mailinde "paymentBaseUrl" alanında iletilecektir.

Request
{
  "memberId": 0,
  "merchantId": 0,
  "customerId": "string",
  "userCode": "string",
  "txnType": "string",
  "installmentCount": "string",
  "currency": "string",
  "okUrl": "string",
  "failUrl": "string",
  "orderId": "string",
  "totalAmount": "string",
  "merchantLogoUrl": "string",
  "rnd": "string",
  "hash": "string",
  "paymentSystem": "string",
  "description": "string"
}
Response
{
  "token": "string",
  "merchantNo": "string",
  "terminalNo": "string",
  "merchantLogoUrl": "string",
  "techinalErrorReturnUrl": "string",
  "url": "string",
  "responseCode": "string",
  "responseMessage": "string"
}