Transaction Listesi

Tüm işlem listesini almak için kullanılan servistir. Paging yapısı desteklenmektedir. 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
merchantId long 16 Evet 2 Sizin için oluşturulan Üye işyeri ID'si
customerId String 100 Hayır test@test.com CustomerId filtreleme. Dolu gönderilmesi halinde bu customerId'ye ait işlem bilgisi döner
txnTypeList List 20 Hayır "Auth","PreAuth" İşlem Tipi filtreleme. List<> şeklinde birden fazla TxnType gönderebilirsiniz. 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
startDate int 8 Evet 20210325 İşlem başlangıç tarihi. YYYYMMDD dormatında giriniz.
endDate int 8 Evet 20210327 İşlem bitiş tarihi. YYYYMMDD formatında giriniz. Başlangıç tarihinden en fazla 30 gün fazla olabilir.
OrderNo String 2048 Hayır order1:/... OrderId filtreleme. Dolu gönderilmesi halinde bu orderId'ye ait işlem bilgisi döner
cardMask String 16 Hayır 123456**1234 cardMask filtreleme. Dolu gönderilmesi halinde bu maskelenmiş karta ait işlem bilgisi döner
responseCode String 4 Hayır 00 responseCode filtreleme. Dolu gönderilmesi halinde bu responseCode'daki işlem bilgileri döner
authCode String 6 Hayır 123456 authCode filtreleme. Dolu gönderilmesi halinde bu authCode'daki işlem bilgileri döner
pageOptions Paging kontrollerinin yapıldığı sınıftır.
page int - Evet 1 Listelenmesi istenen sayfa numarası
pageSize int - Evet 20 Bir sayfada listelenecek işlem adedi
sortOrder String 4 Evet Asc, Desc Bir sayfada listelenecek işlem adedir. Son yapılan işlemler önce gelmesi isteniyorsa "Desc" yazılmalıdır.
sortField String 35 Evet 1 Sıralanması istenen alan adı. Default SaleDate girilebilir.
Servisten dönen parametreler şu şekildedir:
Parametre ismi Tip Uzunluk Açıklama
orderNo string 2048 Sipariş numarası
requestIp string 100 İstemci IP numarası
txnType string 20 İşlem türü. Auth --> Satış, PreAuth --> Ön Provizyon, PostAuth --> Provizyon kapama, Void --> İptal, Refund --> İade, Inquiry --> Ödeme sorgulama, QrAuth --> QR kod ile ödeme, PointAuth --> Puanlı Ödeme
cardMask string 16 Kart numarası (maskeli)
saleDate int 14 Staış tarihi. YYMMDDhhmmss formatındadır.
bankOrderNo string 2048 Bankaya iletilen sipariş numarası
responseCode string 4 Cevap kodu. 0000 --> Başarılı , Diğerleri başarısız
responseMessage string 2048 Cevap açıklaması
txnStatus string 16 İşlem statüsü
vposId int - Banka Sanal POS ID bilgisi
cardId int - Kayıtlı kart ile işlem yapılmışsa bu kart id bilgisini belirtir.
hostReference string 2048 Banka host referans numarası
amount decimal - İşlem tutarı. (Komisyon veya İndirim hariç)
totalAmount string - İşlem son tutarı. (Komisyon veya İndirim varsa bu tutara yansımaktadır). İptal, İade, Kısmi iade olursa bu tutar güncellenmektedir.
originalAmount decimal - İşlem orjinal tutarı
discountRate decimal (6,2) İndirim oranı
usedPoint decimal - Kullanılan puan
txnStatus string 1 İşlem durumu. 'Y' --> 'Başarılı', 'E' --> 'Başarısız', 'P' --> 'Beklemede', 'V' --> 'İptal Edildi', 'R' --> 'İade Edildi', 'A' --> 'Satışa Çevrildi', 'K' --> 'Kısmi İade Edildi'
currencyCode string 3 Kur bilgisi. (TL:949, USD:840, EUR:978, GBP:826, JPY:392, RUB:643)
authCode string 6 Otorizasyon numarası
description string 2048 Üye işyeri tarafından işlem sırasında gönderilen işlem açıklaması.
rnd string 2048 Üye işyeri tarafından işlem sırasında gönderilen rnd bilgisi.
installmentCount string 2 Taksit bilgisi. (Boş ve 0 olanlar peşin olarak kabul edilebilir)
customerId string 100 Üye işyeri tarafından işlem sırasında gönderilen customer Id bilgisi.
theedSecure boolean - işlem bilgisi. "true": 3d secure , "false": Nonsecure
userCode string 100 Üye işyeri tarafından işlem sırasında gönderilen userCode bilgisi.
campaignType string 250 Kampanya varsa kampanya türü bilgisi.
campaignDescription string 2048 Kampanya varsa kampanya açıklama bilgisi.
extraData string 2048 İşleme ait ek bilgi
commissionRate decimal (6,2) Komisyon Oranı
maturityPeriod string 4 Vade Dönemi
paymentFrequency string 4 Vade Ödeme Sıklığı
cardHolderName string 100 Kart Sahibi Adı Soyadı
Ö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/GetTransactionList

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

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

Request
{
  "merchantId": 0,
  "orderNo": "string",
  "txnTypeList": [
    "string"
  ],
  "cardMask": "string",
  "startDate": 0,
  "endDate": 0,
  "responseCode": "string",
  "txnStatus": "string",
  "authCode": "string",
  "customerId": "string",
  "pageOptions": {
    "page": 1,
    "pageSize": 20,
    "sortOrder": "Desc",
    "sortField": "1"
  }
}
Response

{
  "fail": false,
  "statusCode": 200,
  "result": {
    "page": 1,
    "pageSize": 10,
    "totalPage": 18,
    "totalCount": 175,
    "data": [
      {
        "orderNo": "DK637503110320125411",
        "requestIp": null,
        "txnType": "Auth",
        "txnSubType": null,
        "merchantVposId": 64,
        "cardMask": null,
        "saleDate": 20210302194401,
        "bankOrderNo": "DK637503110320125411",
        "responseCode": null,
        "cardId": 0,
        "vposId": 0,
        "hostReference": null,
        "amount": 10.1,
        "discountRate": 0,
        "originalAmount": 10,
        "usedPoint": 0,
        "txnStatus": "P",
        "currencyCode": 949,
        "authCode": null,
        "description": "Payzee Demo",
        "responseMessage": null,
        "rnd": "637503110320126029",
        "installmentCount": null,
        "totalAmount": "10.10",
        "customerId": "1234",
        "theedSecure": false,
        "userCode": "berk.ustunel@birlesikodeme.com",
        "campaignType": null,
        "campaignDescription": null,
        "campaignValue": null,
        "extraData": null,
        "commissionRate": 1
      },
      .....
      ]
      }
}