İşlem Listeleme Servisi

İşlem Listeleme Servisi İstek Modeli;

Metod	API URL	Parametreler
POST	https://base-url/api/services/GetPaymentList	JSON File

Servise gönderilmesi gereken parametreler şu şekildedir;

Parametre	Tip	Zorunlu	Açıklama
MERCHANT	string	Evet	Üye iş yerine özel oluşturulan eşsiz kimlik bilgisidir.
MERCHANT_KEY	string	Evet	Üye iş yerine özel oluşturulan anahtar bilgisidir.
START_DATE	string	Evet	Sorgu için başlangıç tarih bilgisidir.
END_DATE	string	Evet	Sorgu için bitiş tarih bilgisidir.

Servise gönderilecek örnek bir JSON dosyası şu şekildedir;

                                            
{
      "MERCHANT": "TEST1234" , 
      "MERCHANT_KEY": "4oK26hK8MOXrIV1bzTRVPA==" ,
      "START_DATE" : "01-06-2020",
      "END_DATE" : "05-06-2020"
}
                                        

İşlem Listeleme Servisi Cevap Mesajı;

Servisten işlem sonrasında gönderilen cevap mesajına ait parametreler şu şekildedir;

İşlem Listeleme Servisi Cevap Mesajı Parametreleri

Parametre	Tip	Zorunlu	Açıklama
ID	int	Evet	Ödeme için sistem tarafından oluşturulan id bilgisidir.
MERCHANT	string	Evet	Üye iş yerine özel oluşturulan eşsiz isim bilgisidir.
DEALERID	int	Evet	Üye iş yerine özel oluşturulan eşsiz id bilgisidir.
DEALER_CODE	int	Evet	Üye iş yerine özel oluşturulan eşsiz kod bilgisidir.
INSERT_DATETIME	string	Evet	Ödemenin sisteme kaydedildiği zaman bilgisidir.
CARD_TYPE	string	Evet	Kart tipi bilgisidir.
CARD_NUMBER	string	Evet	Ödeme işleminin gerçekleştirileceği karta ait 16 haneli kart numarası bilgisidir. Kart bilgisi şifrelenmiş şekilde paylaşılır.
CARD_NAME	string	Evet	Kart isim bilgisidir.
CARD_BANK_NAME	string	Evet	Kartın ait olduğu banka bilgisidir.
CARD_FAMILY	string	Evet	Kart ailesi bilgisidir.
CURRENCY	string	Evet	Ödeme para birimi bilgisidir. Şu an için sadece “TRY, USD, EUR, GBP” kullanılmaktadır.
VIRTUALPOS_NAME	string	Evet	Sanal pos isim bilgisidir.
STATUS_NAME	string	Evet	Durum bilgisidir.
INSTALLMENT	int	Evet	Ödeme işlemine ait taksit bilgisidir.
AMOUNT	string	Evet	Ödeme işlemine ait miktar bilgisidir.
COMMISSION_AMOUNT	double	Evet	Komisyon miktarı bilgisidir.
VIRTUAL_POS_COMMISSION_AMOUNT	double	Evet	Sanal pos komisyon miktarı bilgisidir.
DEALER_PAYMENT_REF_CODE	string	Evet	Üye iş yeri ödeme referans kod bilgisidir.
COMMISSION_RATE	double	Evet	Komisyon oranı bilgisidir.
CUSTOMER_NAME	string	Evet	Müşteri isim bilgisidir.
CUSTOMER_GSM	string	Evet	Müşteri telefon bilgisidir.
USER_NAME	string	Evet	Kullanıcı adı bilgisidir.
CANCEL_REQUEST	string	Evet	İptal isteği olup olmadığı bilgisidir.
DEALER_NAME	string	Evet	Üye iş yeri isim bilgisidir.
STATUS_ID	int	Evet	Durum id bilgisidir.
JSONDATE	string	Evet	Json tarih bilgisidir.
JSONPAYMENT	string	Evet	Json ödeme bilgisidir.
CC_HASH	string	Evet	Kredi katı hash bilgisidir.
PAYMENT_BANK_CODE	string	Evet	Bankadan ödeme işlemi için dönen ödeme kodu bilgisidir.
TRANSACTIONS	array	Evet	Ödeme işlemine ait gerçekleşen tüm işlem hareketlerine ait hareket detaylarını içeren Json nesne dizisidir.
PHYSICAL_POS_ID	int	Evet	Ödeme işleminin gerçekleştiği posun benzersiz numarası..
PHYSICAL_POS_TITLE	string	Evet	Ödeme işleminin gerçekleştiği posun adı.
PAYMENT_WAY	string	Evet	Ödeme işleminin gerçekleşme yöntemi.

TRANSACTION

Parametre	Tip	Zorunlu	Açıklama
TRANSACTION_ID	int	Evet	Alt işlem hareketine ait benzersiz id bilgisidir.
STATUS_NAME	string	Evet	Alt işlem hareketine ait durum bilgisidir.
STATUS_ID	int	Evet	Alt işlem hareketine ait durum id bilgisidir.
AMOUNT	string	Evet	Alt işlem hareketine ait tutar bilgisidir.
DATE	string	Evet	Alt işlem hareketine ait tarih bilgisidir.
MERCHANT_AMOUNT_TRANSFER_DETAIL	string	Evet	Bu kısımda ödeme işlemine bağlı gerçekleşen alt işlem hareketindeki tutarın transfer detay bilgileri verilir.
SUB_MERCHANT_DETAILS	array	Evet	Bu kısım sadece pazaryeri üye iş yerleri için dolu gelecektir. Diğer üye iş yerleri için bu alandaki bilgiler "null" olarak döner. Ödeme işleminde gerçekleşen tutarın ne kadarının pazaryerine ait hangi mağazalara gönderildiği veya gönderileceği bilgisidir.

SUB_MERCHANT_DETAILS

Parametre	Tip	Zorunlu	Açıklama
EXTERNAL_ID	string	Evet	Mağaza(submerchant)'nın pazaryerin(merchant) sistemindeki ID bilgisidir. Bu bilgi pazaryeri tarafından atanmaktadır.
AMOUNT	string	Evet	Ödeme işlemindeki tutarın mağazaya gönderilecek veye gönderilen kısımıdır.
DATE	string	Evet	İşlemin gerçekleştirildiği tarih bilgisidir.
SUB_MERCHANT_AMOUNT_TRANSFER_DETAIL	string	Evet	Bu kısımda magazaya ait işlem hareketindeki tutarın transfer detay bilgileri verilir.

SUB_MERCHANT_AMOUNT_TRANSFER_DETAIL

Parametre	Tip	Zorunlu	Açıklama
EXTRACT_ID	int	Evet	Alt işlem transfer numarasıdır.
SENDED_AMOUNT	string	Evet	Transfer edilen tutar bilgisidir.
SENDED_DATE	string	Evet	Transfer edilen tarih bilgisidir.

RETURN_CODE	string	Evet	Dekont listeleme işlemi sonucu durumu kod bilgisidir.
RETURN_MESSAGE	string	Evet	Dekont listeleme işlemi sonucu durum mesaj bilgisidir.
STATUS	string	Evet	Dekont listeleme işlemi sonucuna ait durum bilgisidir.

PRODUCTS

Parametre	Tip	Zorunlu	Açıklama
PAYMENT_ID	int	Hayır	İlgili işlemin ödeme ID bilgisidir.
PRODUCT_ID	string	Evet	Ürünün ID bilgisidir.
PRODUCT_NAME	string	Evet	Ürünün isim bilgisidir.
PRODUCT_CATEGORY	string	Evet	Ürünün kategori bilgisidir.
PRODUCT_DESCRIPTION	string	Evet	Ürünün açıklama bilgisidir.
PRODUCT_AMOUNT	decimal	Hayır	Ürünün tutar bilgisidir.

                                            
{
    "paymentList": [
        {
            "ID": 000001,
            "MERCHANT": "TEST1234",
            "DEALERID": 1,
            "DEALER_CODE": 1,
            "INSERT_DATETIME": "/Date(1591127723720)/",
            "CARD_TYPE": "DEBIT",
            "CARD_NUMBER": "654321******1234",
            "CARD_NAME": "Name Surname",
            "CARD_BANK_NAME": "turkekonomibankasia.s.",
            "CARD_FAMILY": null,
            "CURRENCY": "TRY",
            "VIRTUALPOS_NAME": "İş Bankası",
            "STATUS_NAME": "Ödeme - Başarılı",
            "STATUS_ID": 3,
            "INSTALLMENT": 1,
            "AMOUNT": 88.50,
            "COMMISSION_AMOUNT": 1.9912500,
            "VIRTUAL_POS_COMMISSION_AMOUNT": 0.9027000,
            "DEALER_PAYMENT_REF_CODE": "20202020202020",
            "COMMISSION_RATE": 0.02250,
            "CUSTOMER_NAME": "Name Surname",
            "CUSTOMER_GSM": "5435434343",
            "USER_NAME": null,
            "CANCEL_REQUEST": false,
            "DEALER_NAME": null,
            "JSONDATE": null,
            "JSONPAYMENT": null,
            "CC_HASH": null,
            "PAYMENT_BANK_CODE": "444444",
            "TRANSACTIONS": [
                {
                    "TRANSACTION_ID": 343666,
                    "STATUS_NAME": "Ödeme - Başarılı",
                    "STATUS_ID": 3,
                    "AMOUNT": "88,50",
                    "DATE": "19.04.2020 18:35:09",
                    "MERCHANT_AMOUNT_TRANSFER_DETAIL": {
                        "EXTRACT_ID": 5715,
                        "SENDED_AMOUNT": "7,42",
                        "SENDED_DATE": "4.05.2020 11:58:11"
                    },
                    "SUB_MERCHANT_DETAILS": [
                        {
                            "EXTERNAL_ID": "999999",
                            "AMOUNT": "79,09",
                            "DATE": "19.04.2020 18:35:09",
                            "SUB_MERCHANT_AMOUNT_TRANSFER_DETAIL": {
                                "EXTRACT_ID": 5779,
                                "SENDED_AMOUNT": "79,09",
                                "SENDED_DATE": "4.05.2020 11:57:28"
                            }
                        }
                    ]
                }
            ]
        },
        {
            "ID": 000002,
            "MERCHANT": "TEST1234",
            "DEALERID": 1,
            "DEALER_CODE": 1,
            "INSERT_DATETIME": "/Date(1591127580893)/",
            "CARD_TYPE": "DEBIT",
            "CARD_NUMBER": "123456******9876",
            "CARD_NAME": "Name Surname",
            "CARD_BANK_NAME": "ziraat",
            "CARD_FAMILY": null,
            "CURRENCY": "TRY",
            "VIRTUALPOS_NAME": "Ziraatbank",
            "STATUS_NAME": "Ödeme - Başarısız",
            "STATUS_ID": 3,
            "INSTALLMENT": 1,
            "AMOUNT": 47.89,
            "COMMISSION_AMOUNT": 1.0775250,
            "VIRTUAL_POS_COMMISSION_AMOUNT": 0.4884780,
            "DEALER_PAYMENT_REF_CODE": "30303030303030",
            "COMMISSION_RATE": 0.02250,
            "CUSTOMER_NAME": "Name Surname",
            "CUSTOMER_GSM": "5435434343",
            "USER_NAME": null,
            "CANCEL_REQUEST": false,
            "DEALER_NAME": null,
            "JSONDATE": null,
            "JSONPAYMENT": null,
            "CC_HASH": null,
            "PAYMENT_BANK_CODE": "222222",
            "TRANSACTIONS": [
                {
                    "TRANSACTION_ID": 343666,
                    "STATUS_NAME": "Ödeme - Başarılı",
                    "STATUS_ID": 3,
                    "AMOUNT": "47,89",
                    "DATE": "19.04.2020 18:35:09",
                    "MERCHANT_AMOUNT_TRANSFER_DETAIL": {
                        "EXTRACT_ID": 5715,
                        "SENDED_AMOUNT": "2,88",
                        "SENDED_DATE": "4.05.2020 11:58:11"
                    },
                    "SUB_MERCHANT_DETAILS": [
                        {
                            "EXTERNAL_ID": "999999",
                            "AMOUNT": "43,93",
                            "DATE": "19.04.2020 18:35:09",
                            "SUB_MERCHANT_AMOUNT_TRANSFER_DETAIL": {
                                "EXTRACT_ID": 5779,
                                "SENDED_AMOUNT": "43,93",
                                "SENDED_DATE": "4.05.2020 11:57:28"
                            }
                        }
                    ]
                }
            ],
            "PRODUCTS": [
                {
                    "PAYMENT_ID": 123456,
                    "PRODUCT_ID": 25,
                    "PRODUCT_NAME": "Elektronik Ev Aletleri",
                    "PRODUCT_CATEGORY": "Ev Aletleri",
                    "PRODUCT_DESCRIPTION": "Elektronik Alet Satışı",
                    "PRODUCT_AMOUNT": 100.00
                }
            ]
        }
    ],
    "RETURN_CODE": "0",
    "RETURN_MESSAGE": "SUCCESS",
    "STATUS": "SUCCESS"
}
                                        

İşlem durum sorgulama cevap mesajında STATUS parametresinin değeri SUCCESS ve RETURN_CODE parametresinin değeri 0 olarak dönmesi işlem durum sorgulamasının başarılı olarak gerçekleştiğini ifade etmektedir.

Ödeme ile Ödeme Alt İşlem(Transaction) Durum Kodları ve Açıklamaları;

Ödeme ve Ödeme Alt İşlem(Transaction)leri detaylarında dönen STATUS_NAME ve STATUS_ID açıklamalarının detayları şu şekildedir;

STATUS_ID	STATUS_NAME	Açıklama
3	Ödeme - Başarılı	Başarılı olarak gerçekleşmiş ödemelerin ve alt işlemlerin sonucuda dönen durum bilgisidir.
4	Ödeme - Başarısız	Başarısız olarak gerçekleşmiş ödemelerin ve alt işlemlerin sonucuda dönen durum bilgisidir.
5	İptal - Başarılı	Başarılı olarak gerçekleşmiş iptal ödemelerin ve alt işlemlerin sonucuda dönen durum bilgisidir.
6	İptal - Başarısız	Başarısız olarak gerçekleşmiş iptal ödemelerin ve alt işlemlerin sonucuda dönen durum bilgisidir.
7	İade - Başarılı	Başarılı olarak gerçekleşmiş iade ödemelerin ve alt işlemlerin sonucuda dönen durum bilgisidir.
8	İade - Başarısız	Başarısız olarak gerçekleşmiş iade ödemelerin ve alt işlemlerin sonucuda dönen durum bilgisidir.