API üzerinden Ödeme Raporu'nu almak için kullanılan servistir. Bu serviste istek yapabilmesi için token bilgisinin Header'da gönderilmesi gerekmektedir. Buradan Ü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 |
|---|---|---|---|---|---|
| txnStartDate | string | 10 | Hayır | 2021-10-01 | Satış başlangıç tarihi; yıl-ay-gün olarak gönderim yapılmalıdır. |
| txnEndDate | string | 10 | Hayır | 2021-10-30 | Satış bitiş tarihi; yıl-ay-gün olarak gönderim yapılmalıdır. |
| paymentStartDate | string | 10 | Hayır | 2021-10-30 | Ödeme başlangıç tarihi; yıl-ay-gün olarak gönderim yapılmalıdır. |
| paymentEndDate | string | 10 | Hayır | 2021-10-30 | Ödeme bitiş tarihi; yıl-ay-gün olarak gönderim yapılmalıdır. |
Servisten Dönen Parametreler Aşağıdadır:
| Parametre Adı | Tip | Açıklama |
|---|---|---|
| bankOrderNumber | string | İşlemin banka sipariş numarası bilgisi |
| cardBrand | string | İşlem yapılan kartın marka bilgisi |
| cardLoyaltyBrand | string | İşlem yapılan kartın program bilgisi |
| cardType | string | İşlem yapılan kart tipi bilgisi |
| commission | decimal | İşlemin Birleşik Ödeme komisyon tutarı bilgisi |
| commissionRate | decimal | İşlemin Birleşik Ödeme komisyon oranı bilgisi |
| headCommission | decimal | İşlemin head kullanıcısı komisyon tutarı bilgisi |
| headCommissionRate | decimal | İşlemin head kullanıcısı komisyon oranı bilgisi |
| headIban | string | İşlemin head kullanıcısına ödeme yapılacak iban bilgisi |
| headTradeName | string | İşlemin head hesabınınişyeri adı bilgisi |
| iban | string | İşyerine ödeme yapılacak iban bilgisi |
| installmentCount | decimal | İşlemin taksit sayısı bilgisi |
| issuerBankName | string | İşlem yapılan kartın banka bilgisi |
| maskedCardNumber | string | İşlem yapılan maskeli kart bilgisi |
| merchantNumber | string | İşlem yapılan işyeri numarası bilgisi |
| netAmount | decimal | İşlemin işyerine ödenecek tutar bilgisi |
| payzeeAuthorizationNumber | string | İşlemin otorizasyon kodu bilgisi |
| payzeeCreateDate | string | İşlemin oluşturulma tarihi |
| payzeeCurrencyCode | string | Kur bilgisi. (TL:949, USD:840, EUR:978, GBP:826, JPY:392, RUB:643) |
| payzeeDiscountRateAcq | decimal | İşlemin indirim oranı bilgisi |
| payzeeMerchantName | string | İşlemin işyeri adı bilgisi |
| payzeeModifyDate | string | İşlemin güncellenme tarihi |
| payzeePfAcquiredBankName | string | İşlemin geçtiği POS bankası bilgisi |
| trnAmount | decimal | İşlem yapılan tutar bilgisi |
| payzeeTrnDate | string | Payzee işlem tarihi |
| payzeeTrnOrderId | string | İşlemin sipariş numarası bilgisi |
| tradeName | string | İşyeri adı bilgisi |
| transactionType | string | İşlem tipi bilgisi |
| trnStatus | string | İşlem durumu bilgisi |
| usedReward | decimal | İşlemde kullanılan puan tutarı |
| paymentType | string | Hakediş ödeme tipi bilgisi |
| productId | string | Ürün Idsi |
| productName | string | Ürün İsmi |
HTTP Method: POST
Content-Type: application/json
TEST URL: https://ppgpayment-test.birlesikodeme.com:20000/api/ppg/Report/GetPaymentList
PROD URL: https://{baseUrl}/api/ppg/Report/GetPaymentList
*Prod için baseUrl adresi,size entegrasyon mailinde "paymentBaseUrl" alanında iletilecektir.
Request
{ "trnDate1": "2021-10-01", "trnDate2": "2021-10-30" }
Response
{ "fail": false, "statusCode": 200, "result": [ { "bankOrderNumber": "string", "cardBrand": "string", "cardLoyaltyBrand": "string", "cardTransferStatus": "string", "cardType": "string", "commission": 0.00, "commissionRate": 0,0, "eftStatus": "string", "headCommission": 0, "headCommissionRate": 0, "headIban": "string", "headTradeName": "string", "iban": "string", "installmentCount": 1, "issuerBankName": "string", "maskedCardNumber": "string", "merchantNumber": "string", "netAmount": 0,00, "payzeeAuthorizationNumber": "string", "payzeeCreateDate": "string", "payzeeCurrencyCode": "string", "payzeeDiscountRateAcq": 0, "payzeeMerchantName": "string", "payzeeModifyDate": "string", "payzeePfAcquiredBankName": "string", "trnAmount": 0, "payzeeTrnDate": "string", "payzeeTrnOrderId": "string", "tradeName": "string", "transactionType": "string", "trnStatus": "string", "usedReward": 0, "paymentType": "string", "totalCount": 0, "totalAmount": 0, "totalNetAmount": 0, "totalCommissionAmount": 0, "totalHeadCommissionAmount": 0 }