1. Servis Genel Bilgileri
Servis istenen tarih aralığında, TPAY servislerinden geçmiş satış ve iade işlemlerine ait finansal verilerin listelenmesi amacıyla kullanılmaktadır.
- Servis adı : queryOrderVpf TPAY Servis url bilgileri :
- Apigw üzerinden erişimde kullanılacak url bilgileri :
2. Servis Request Parametreleri
|
name |
M/O |
description |
requestHeader |
applicationName |
m |
Servisi çağıran üye işyerine verilen applicationName |
|
applicationPwd |
m |
Servisi çağıran üye işyerine verilen application’a ait password |
|
transactionDateTime |
m |
Servisin çağırıldığı tarih saat, örnek data :
20160309084056197 |
|
transactionId |
m |
Servisin her çağırımında unique olacak şekilde üretilerek gönderilmesi gereken id’dir. |
Parameters |
TRANSACTION_START_DATE |
m |
Listelenmek istenen kayıtların tarih aralığına ait başlangıç tarihi |
|
TRANSACTION_END_DATE |
m |
Listelenmek istenen kayıtların tarih aralığına ait bitiş tarihi |
|
MERCHANT_CODE |
m |
Application’a bağlı, işlem verisi listelenmek istenen Merchant_code bilgisidir. |
|
SIZE |
m |
Servis çağırımında listelenmesi istenen kayıt sayısı – Page sayısı size ve total_size göre belirlenir. |
|
PAGE |
m |
Servis çağırımında listelenmesi istenen page numarası |
|
BASKET_ID |
o |
Opsiyonel olarak provisionAll servisinde veri gönderilmişse, ödeme kaydına bu veri ilişkilendirilir. Bu dokümanda anlatılan serviste transaction için veri döner. |
|
MERCHANT_SPECIAL_DATA |
o |
Opsiyonel olarak provisionAll servisinde veri gönderilmişse, ödeme kaydına bu veri ilişkilendirilir. Bu dokümanda anlatılan serviste transaction için veri döner. |
|
MERCHANT_SPECIAL_DATA2 |
o |
Opsiyonel olarak provisionAll servisinde veri gönderilmişse, ödeme kaydına bu veri ilişkilendirilir. Bu dokümanda anlatılan serviste transaction için veri döner. |
|
MERCHANT_SPECIAL_DATA3 |
o |
Opsiyonel olarak provisionAll servisinde veri gönderilmişse, ödeme kaydına bu veri ilişkilendirilir. Bu dokümanda anlatılan serviste transaction için veri döner. |
|
ORDER_ID |
O |
Sorgulanmak istenen işleme ait, provisionAll servis dönüşünde yer alan Order_id bilgisidir. İşleme ait uniqueId’dir. |
Örnek request :
{
“requestHeader”: {
“applicationName”: “***************”,
“applicationPwd”: “******************”,
“clientIPAddress”: “10.252.187.81”, “transactionDateTime”: “20160309084056197”,
“transactionId”: “12345678901234567893”
},
“transactionStartDate”: “01-05-2024”,
“transactionEndDate”: “30-05-2024”,
“merchantCode”: “**************”,
“clientBasketId”: “”,
“merchantSpecialData”: “”,
“vposOrderId”: “”,
“size”: “12”,
“page”: “0”
}
3. Servis Response Parametreleri
|
Name |
description |
responseHeader |
responseCode |
0 → success
<> 0 ise servis hata vermiş demektir. |
|
responseDateTime |
Servisin response tarihi |
|
responseDescription |
Servis hata mesaj açıklamasıdır |
|
transactionId |
Servis çağırımına ait transactionId’dir. Listelenen işlemlere ait değil, queryOrderVpf servisinin çağırımına ait id’dir. |
Parameters |
TOTAL_SIZE |
Sorgulanan tarih aralığındaki toplam kayıt sayısını verir. |
|
CURRENT_PAGE |
Listelenen page’e ait numarayı verir. |
|
TOTAL_PAGE |
Requestte gönderilen size ve total_size’a göre toplam kaç sayfada verinin çekileceğini gösterir. Page number 0’dan başlar. Örnek olarak total_page = 3 ise requestte sırasıyla 0, 1, 2 gönderilerek tüm kayıtlar alınabilir. |
|
MERCHANT_LEGAL_NAME |
Üye işyerinin adı |
|
TRANSACTION_TYPE |
ödeme tipi alabileceği değerler : SATIS, IADE |
|
Merchant_code |
requestte gönderilen merhant code dönülür |
|
Sub_merchant_code |
response’ta sub_dealer_code varsa dönülür |
|
INSTALLMENT_COUNT |
taksit sayısı |
|
TRANSACTION_DATE |
işlemin yapıldığı tarih |
|
VALOR_DATE |
ödemenin yapılacağı tarih |
|
PAYCELL_COMMISSION_RATE |
komisyon oranı |
|
CALC_COMMISSION_AMOUNT |
komisyon tutarı |
|
CC_NUMBER |
İşlem yapılan kartın ilk 4 hanesi |
|
VPOS_ORDER_ID |
İşleme ait unique_id |
|
CLIENT_BASKET_ID |
Opsiyonel bir bilgidir, ProvisionAll’da gönderilmiş ise bu serviste döner. |
|
MERCHANT_SPECIAL_DATA |
Opsiyonel bir bilgidir, ProvisionAll’da gönderilmiş ise bu serviste döner. |
|
MERCHANT_SPECIAL_DATA2 |
Opsiyonel bir bilgidir, ProvisionAll’da gönderilmiş ise bu serviste döner. |
|
MERCHANT_SPECIAL_DATA3 |
Opsiyonel bir bilgidir, ProvisionAll’da gönderilmiş ise bu serviste döner. |
|
CARD_TYPE |
Kartın tipini verir. Credit_Card, Debit_Card vb. |
|
CARD_FAMILY |
Kartın organizasyon bilgisini verir. VISA,
MASTERCARD vb. |
|
BOLGE |
Bu alan opsiyonel olarak kullanılır, işlemin yapıldığı üye işyerine ait detay veri döner. |
|
IBAN_NO |
Üye işyerinin hak edişinin ödeneceği IBAN bilgisidir. |
|
FOREIGN_CARD |
İşlem yapılan kartın yabancı kart olup olmadığını döner. |
Örnek Response :
{
“responseHeader”: {
“transactionId”: “12345678901234567893”,
“responseDateTime”: “20240813161858955”,
“responseCode”: “0”,
“responseDescription”: “Success”
},
“extraParameters”: null,
“pageInfoResponse”: {
“totalSize”: “10”,
“currentPage”: “0”,
“totalPage”: “5”
},
“items”: [
{
“merchantLegalName”: “TÖHAŞ ÖDEME ELEKTRONİK”,
“taxNumber”: “8806546623”,
“subMerchantNumber”: “201769”,
“terminalNumber”: “60416”,
“subDealerCode”: “100000511”,
“transactionType”: “SATIS”,
“installmentCount”: “1”,
“transactionDate”: “20-05-2024”,
“valorDate”: “31-05-2024”,
“paycellCommissionRate”: “1”,
“calcCommissionAmount”: “0.15”,
“grossAmount”: “15”,
“calcNetAmount”: “14.85”,
“ccNumber”: “5200”,
“vPosOrderId”: “664b2853dd81876c744d3b68”,
“applicationId”: “1421”,
“clientBasketId”: null,
“merchantSpecialData”: null,
“merchantSpecialData2”: null,
“merchantSpecialData3”: null,
“cardType”: “Credit_Card”,
“cardFamily”: VISA,
“bolge”: null,
“ibanNo”: TR123456119012345678901276, “foreignCard”: “0”
},
{
“merchantLegalName”: “TÖHAŞ ÖDEME ELEKTRONİK”,
“taxNumber”: “8806546623”,
“subMerchantNumber”: “201769”,
“terminalNumber”: “60416”,
“subDealerCode”: null,
“transactionType”: “SATIS”,
“installmentCount”: “1”,
“transactionDate”: “20-05-2024”,
“valorDate”: “31-05-2024”,
“paycellCommissionRate”: “1”,
“calcCommissionAmount”: “0.2”,
“grossAmount”: “20”,
“calcNetAmount”: “19.8”,
“ccNumber”: “520019** **** **08”,
“vPosOrderId”: “664b4809dd818721d24d3b84”,
“applicationId”: “1421”,
“clientBasketId”: null,
“merchantSpecialData”: null,
“merchantSpecialData2”: null,
“merchantSpecialData3”: null,
“cardType”: “Credit_Card”,
“cardFamily”: VISA,
“bolge”: null,
“ibanNo”: TR123456119012345678901276, “foreignCard”: “0”
}
]
}
4. Hata kodları
Hata kodu |
Açıklama |
TPAY hata dönüşü |
0 |
Success |
İşlem Başarılı |
10509 |
En fazla 90 günlük veri listelenebilir. |
En fazla 90 günlük veri listelenebilir. |
10507 |
Geçersiz Tarih Formatı. Olması gereken dd-
MM-yyyy |
Geçersiz Tarih Formatı. Olması gereken dd-
MM-yyyy |