İşlem Sorgulama Servisi

İşlem Sorgulama Servisi İstek Modeli;

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

Servise gönderilmesi gereken parametreler şu şekildedir;

İşlem Sorgulama Servisi İstek Mesajı Parametreleri

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.
ORDER_REF_NUMBER	string	Evet	Üye iş yeri tarafından ödeme işlemi isteği gönderilirken verilmiş olan referans numarası bilgisidir.

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

{
      "MERCHANT": "TEST1234" , 
      "MERCHANT_KEY": "4oK26hK8MOXrIV1bzTRVPA==" ,
      "ORDER_REF_NUMBER" : "0.54251300 1595848596|93"
}
                                        

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

İşlem Sorgulama Servisi Cevap Mesajı Parametreleri

Parametre	Tip	Zorunlu	Açıklama
RETURN_CODE	string	Evet	İşlem sorgulama işlemi sonucu durumu kod bilgisidir.
RETURN_MESSAGE	string	Evet	İşlem sorgulama işlemi sonucu durum mesaj bilgisidir.
STATUS	string	Evet	İşlem sorgulama işlemi sonucu durum bilgisidir.
ID	string	Evet	Tekrarlı ödeme id bilgisi
DATE	string	Evet	Ödeme işlemi için işlem tarihi bilgisidir.
RECURRING_COUNT	string	Evet	Tekrar sayısı
TRY_COUNT_LIMIT	int	Evet	Tekrarı deneme sayısı
AMOUNT	string	Evet	Tekrarlı ödeme tutar bilgisi
CURRENCY	string	Evet	Tekrarlı ödeme işlemi para birimidir.('TRY','USD','EUR')
SUCCES_COUNT	string	Evet	Tekrarlı ödemeye ait başarılı tekrar sayısı bilgisi
DEALER_REF_NO	string	Evet	Üye iş yeri tarafından ödeme işlemi isteği gönderilirken verilmiş olan referans numarası bilgisidir.
CUSTOMER_GSM	string	Evet	Müşteri telefon bilgisidir.
CUSTOMER_EMAIL	string	Evet	Müşteri email bilgisidir.
COSTUMER_NAME	string	Evet	Müşteri isim bilgisidir.
COSTUMER_ADRESS	string	Evet	Müşteri adres bilgisidir.

CARDS

Parametre	Tip	Zorunlu	Açıklama
ID	int	Evet	Kartın sistem tarafından atanan ID bilgisidir.
CARD_OWNER	string	Evet	Kart sahibinin ad ve soyadı bilgisidir.
MASKED_CARD_NUMBER	string	Evet	Kartın 16 haneli maskelenmiş kart numarası bilgisidir.

RECURRING_PAYMENT_TRANSACTIONS

Parametre	Tip	Zorunlu	Açıklama
RECURRING_NO	int	Evet	N. tekrar
PAYMENT_DATE	string	Evet	Tekrarın çekileceği tarih
REF_NO	int	Evet	Tekrara ait referans numarası bilgisi. Ödeme işlemi sorgulama ve tekrar iptal etme servisinde kullanılabilir.
STATUS	string	Evet	Durum bilgisi.
TRIES_COUNT	string	Evet	Tekrarın denenme sayısı.
SUCCES_DATE	string	Evet	Tekrarın başarılı olduğu tarih.
PAYMENT_ID	array	Evet	Tekrar başarılı ise ödeme id bilgisi.
IS_ACTIVE	array	Evet	Tekrarın aktiflik durumu

RECURRING_PAYMENT_TRIES

Parametre	Tip	Zorunlu	Açıklama
PAYMENT_ID	string	Evet	Ödeme id bilgisi.
STATUS	string	Evet	Tekrar deneme durumu.
DESCRIPTION	string	Evet	Tekrar denemesine ait açıklama.
TRY_DATE	string	Evet	Tekrar denemesinin yapıldığı tarih.

İşlem Sorgulama Servisi Cevap Mesajı Parametreleri

{
    "RETURN_CODE": "0",
    "RETURN_MESSAGE": "SUCCESS",
    "STATUS": "SUCCESS",
    "ID": 343666,
    "DATE": "24.06.2022",
    "RECURRING_COUNT": "10",
    "TRY_COUNT_LIMIT": "5",
    "AMOUNT": "1250,00",
    "CURRENCY": "TRY",
    "SUCCESS_COUNT": "3",
    "DEALER_REF_NO": "ORDER_REF_NUMBER",
    "COSTUMER_GSM": "5553332211",
    "COSTUMER_EMAIL": "[email protected]",
    "COSTUMER_NAME": "TEST USER",
    "COSTUMER_ADRESS": "TEST ADRESS",
    "CARDS": [
        		{
        			"ID": 150,
        			"CARD_OWNER": "TEST USER",
        			"MASKED_CARD_NUMBER": "97921000****0001"
        		}
	  ],
    "RECURRING_PAYMENT_TRANSACTIONS": [
            { 
            "RECURRING_NO": 1,
            "PAYMENT_DATE": "24.06.2022",
            "REF_NO": "REF_NO_1",
            "STATUS": "Başarılı",
            "TRIES_COUNT": "1",
            "SUCCESS_DATE": "24.06.2022",
            "PAYMENT_ID": "343312",
            "IS_ACTIVE": "true",
            "RECURRING_PAYMENT_TRIES ": [
                    {
                    "PAYMENT_ID": "343312",
                    "STATUS": "Başarılı",
                    "DESCRIPTION": "Başarılı"
                    "TRY_DATE": "24.06.2022"
                    }
                ]
            },
            { 
            "RECURRING_NO": 2,
            "PAYMENT_DATE": "24.07.2022",
            "REF_NO": "REF_NO_2",
            "STATUS": "Bekliyor",
            "TRIES_COUNT": "0",
            "SUCCESS_DATE": null,
            "PAYMENT_ID": null,
            "IS_ACTIVE": "true",
            "RECURRING_PAYMENT_TRIES ": []
            }
     ]
}                                 

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