İşlem Listeleme Servisi

İşlem Listeleme Servisi İstek Modeli;

Metod
API URL
Parametreler

POST

https://posservice.paypole.com/api/services/GetRecurringPaymentList

JSON File

Servise gönderilmesi gereken parametreler şu şekildedir;

İşlem Listeleme 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.

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-12-2021",
    "END_DATE" : "05-07-2022"
}
                                        

İş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

RETURN_CODE

string

Evet

Tekrarlı ödeme listeleme işlemi sonucu durumu kod bilgisidir.

RETURN_MESSAGE

string

Evet

Tekrarlı ödeme listeleme işlemi sonucu durum mesaj bilgisidir.

STATUS

string

Evet

Tekrarlı ödeme listeleme işlemi sonucu durum mesaj bilgisidir.

RECURRING_PAYMENTS

array

Evet

RECURRING_PAYMENTS

Parametre
Tip
Zorunlu
Açıklama

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.

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.

                                            
{
    "RETURN_CODE": "0",
    "RETURN_MESSAGE": "SUCCESS",
    "STATUS": "SUCCESS",
    "RECURRING_PAYMENTS": [
        {
            "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": "test@test.com",
            "COSTUMER_NAME": "TEST USER",
            "COSTUMER_ADRESS": "TEST ADRESS",
            "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 listeleme servisi cevap mesajında STATUS parametresinin değeri SUCCESS ve RETURN_CODE parametresinin değeri 0 olarak dönmesi işlem listeleme servisinin başarılı olarak gerçekleştiğini ifade etmektedir.

Last updated