YKB Karekod Ödeme Tamamla

QR (karekod) ile ödeme yapma servisini tamamlamak için kullanılır. Bu serviste istek yapabilmesi için token bilgisinin Header'da gönderilmesi gerekmektedir. Bu linkten Üye İşyeri Doğrulama token bilgilerine ulaşabilirsiniz

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.
webUrl String 2048 Hayır https:/.... İşlem web url bilgisi.
description String 2048 Hayır - İşlem açıklama bilgisi.
requestIp String 2048 Hayır 198.00.00.00 İşlem istek IP bilgisi
merchantVposId String 2048 Hayır 01 Üye işyeri POS ID bilgisi
extraData String 2048 Hayır - Ek veri
Servisten dönen parametreler şu şekildedir:
Parametre ismi Tip Uzunluk Açıklama
url string 2048 url
responseCode string 4 Cevap kodu. 0000 --> Başarılı , Diğerleri başarısız
responseMessage string 2048 Cevap açıklaması
orderId string 16 Sipariş ID değeri
txnType string 16 İşlem Tipi. Auth --> Satış, PreAuth --> Ön Provizyon, PostAuth --> Provizyon kapama, Void --> İptal, Refund --> İade, Inquiry --> Ödeme sorgulama, QrAuth --> QR kod ile ödeme, PointAuth --> Puanlı Ödeme
txnStatus string 16 İşlem statüsü
vposId string 16 Banka Sanal POS ID bilgisi
vposName string 64 Banka Sanal POS adı
Ö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/FinalizeQrCode

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

*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",
  "rnd": "string",
  "hash": "string",
  "webUrl": "string",
  "description": "string",
  "requestIp": "string",
  "merchantVposId": 0,
  "extraData": "string"
}
Response
{
  "url": "string",
  "responseCode": "string",
  "responseMessage": "string",
  "orderId": "string",
  "txnType": "string",
  "txnStatus": "string",
  "vposId": 0,
  "vposName": "string"
}