Ödeme sonucu için sorgu servisidir. Ödeme işlemine ait “paymentId” ve “uuid” parametreleri ile ödemenin mevcut durumu sorgulanır. Ödeme sonucu, “paymentResult” nesnesi ile iletilir.
Başarı ile tamamlanmış ödemeler için; success = true, paymentStatusCode = 1, paymentStatusMsg = “success” değerleri ile dönüş sağlanır.
| Metot | Endpoint | Content-Type |
|---|---|---|
| POST | {{baseURL}}/paymapi/v1/transaction/getResult |
application/json |
| Parametre | Tip | Zorunlu | Açıklama |
|---|---|---|---|
| credentials | obj | evet | Güvenlik nesnesi. İşlemi gerçekleşitren kurumu tanımlamak için kullanılır. |
| apiKey | str | evet | API anahtarı |
| hash | str | evet | Bu işlem için üretilen hash değeri. Bknz: Ödeme sorgusu için hash hesaplama |
| paymentId | int | evet | Ödemeye ilişkin ID değeri |
| uuid | str | evet | Ödemeye ilişkin UUID değeri |
{
"credentials":{
"apiKey":"your-api-key",
"hash":"hash-for-transaction"
},
"paymentId": 55,
"uuid": "uuid-for-transaction"
}
| Parametre | Tip | Açıklama |
|---|---|---|
| paymentId | int | Ödemeye ilişkin ID değeri |
| paymentDate | str | Ödeme tarihi |
| paymentUuid | str | Ödemeye ilişkin UUID değeri |
| hash | str | Ödemeye ilişkin hash değeri |
| orderId | str | Siparişe özel, benzersiz ID değeri |
| orderTotal | flt | Ödeme tutarı |
| currencyCode | str | ISO 4217, üç haneli para birimi kodu.(TL için TRY) |
| items | obj arr | Siparişe konu olan ürünlerin listesi |
| name | str | Ürün adı |
| stockCode | str | Ürünün stok kodu |
| quantity | int | Ürün adedi |
| price | flt | Ürün fiyatı |
| customer | obj | Müşteri bilgilerini içeren nesne |
| id | str | Müşteriye özel, benzersiz ID değeri |
| group | str | Müşteri grubu. Varsayılan: Standart “STD” |
| name | str | Müşteri adı |
| surname | str | Müşteri soyadı |
| str | Müşteri e-posta adresi | |
| telephone | str | Müşteri telefon numarası |
| ssn | str | Müşteri TC kimlik numarası |
| address | str | Müşteri adresi |
| city | str | Müşterinin şehri |
| country | str | Müşterinin ülkesi |
| zipCode | str | Müşteri posta kodu |
| ipAddr | str | Müşterinin IP adresi |
| paymentResult | obj | Ödeme sonuç nesnesi |
| success | bln | Ödemenin başarı durumu |
| paymentStatusCode | int | Ödeme durum kodu |
| paymentStatusMsg | str | Ödeme durum mesajı |
| statusCode | int | İşlem durum kodu |
| statusMsg | str | İşlem durum mesajı |
{
"paymentId": 50,
"paymentDate": "2020-11-02 20:47:26",
"paymentUuid": "f021649c-b04b-43bf-8f47-1e52be9ee85f",
"hash": "n2Ehu802sgXF4LWEgLauwwYHu8GV6E=",
"orderId": "1212",
"orderTotal": 20,
"currencyCode": "TRY",
"items": [
{
"name": "Product 1",
"stockCode": "123456",
"quantity": 2,
"price": 5.5
},
{
"name": "Product 2",
"stockCode": "234567",
"quantity": 1,
"price": 9
}
],
"customer": {
"id": "007",
"group": "STD",
"name": "john",
"surname": "doe",
"email": "john.doe@somemail.com",
"telephone": "905554444433",
"ssn": "11122233344",
"address": "Mehterçeşme Mahallesi Cumhuriyet Cad. No:35 Kat:4 Esenyurt",
"city": "Istanbul",
"country": "Turkey",
"zipCode": "34515",
"ipAddr": "88.99.100.200"
},
"paymentResult": {
"success": true,
"paymentStatusCode": 1,
"paymentStatusMsg": "success"
},
"statusCode": 100,
"statusMsg": "OK"
}
Sırası ile, “apiKey” + “uuid” + “secretKey” parametreleri birbirine eklenerek, SHA1 algoritması uygulanır. Elde edilen özet değer, base64 string olarak kodlanır.
base64(sha1(apiKey + uuid + secretKey))
Hash hesaplama, her metot için farklılık göstermektedir.