İşlem Sorgulama Servisi

İşlem Durum Sorgulama Servisi İstek Modeli;

MetodAPI URLParametreler

POST

https://base-url/api/services/ProcessQuery

JSON File

Servise gönderilmesi gereken parametreler şu şekildedir;

ParametreTipZorunluAçı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. Sorgulama yapılacak ödeme işlemi, ilgili üye iş yerine ait belirtilen referans numarası ile eşleştirilerek işlem gerçekleştirilir.

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

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

İşlem Durum Sorgulama Servisi Cevap Mesajı;

Servisten işlem sonrasında gönderilen cevap mesajına ait parametrelerin bazıları tüm üye iş yerleri için kullanılırken, bazı parametreler sadece pazaryeri olarak sisteme tanımlı üye iş yerleri için dolu gelmektedir. Bu parametreler ve açıklamaları şu şekildedir;

İşlem Durum Sorgulama Servisi Cevap Mesajı Parametreleri

ParametreTipZorunluAçıklama

STATUS

string

Evet

Ödeme işlemi sonucu durum bilgisidir.

RETURN_CODE

string

Evet

Ödeme işlemi sonucu durumu kod bilgisidir.

RETURN_MESSAGE

string

Evet

Ödeme işlemi sonucu durum mesaj bilgisidir.

DATE

string

Evet

Sorgu işlemi için işlem tarihi bilgisidir.

PAYMENT_DATE

string

Evet

Ödeme işlemi için işlem tarihi bilgisidir.

REFNO

string

Evet

Ödeme işlemine ait EsnekPos sistemi tarafından verilen referans numarası bilgisidir.

AMOUNT

string

Evet

Ödeme işlemine ait işlem tutarı bilgisidir.

ORDER_REF_NUMBER

string

Evet

Üye iş yeri tarafından ödeme isteğinde, isteğe ait verilen referans numarası bilgisidir.

INSTALLMENT

string

Evet

Ödeme işlemi için istenen taksit sayısı bilgisidir. Tek çekim işlemler için “1” bilgisi dönmektedir.

SUCCESS_TRANSACTION_ID

int

Evet

Ödeme işlemi başarılı olduğunda bu ödeme işlemine ait TRANSACTION ID bilgisini dönmektedir.

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

ParametreTipZorunluAçıklama

TRANSACTION_ID

string

Evet

Alt işlem hareketine ait benzersiz id bilgisidir.

STATUS_NAME

string

Evet

Alt işlem hareketine ait durum 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

ParametreTipZorunluAçı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.

MERCHANT_AMOUNT_TRANSFER_DETAIL, SUB_MERCHANT_AMOUNT_TRANSFER_DETAIL

ParametreTipZorunluAçıklama

EXTRACT_ID

string

Evet

Alt işlem transfer numarasıdır.

SENDED_AMOUNT

string

Evet

Transfer edilen tutar bilgisidir.

SENDED_DATE

string

Evet

Transfer edilen tarih bilgisidir.

                                            
{
    "STATUS": "SUCCESS",
    "RETURN_CODE": "0",
    "RETURN_MESSAGE": "SUCCESS",
    "DATE": "24.09.2020 17:08:10",
    "PAYMENT_DATE": "19.04.2020 18:34:35",
    "REFNO": null,
    "AMOUNT": "1250,00",
    "ORDER_REF_NO": "9.54251311 1595848596|999",
    "INSTALLMENT": "1",
    "COMMISSION": "1,490",
    "TRANSACTIONS": [
        {
            "TRANSACTION_ID": 343666,
            "STATUS_NAME": "Ödeme - Başarılı",
            "STATUS_ID": 3,
            "AMOUNT": "1250,00",
            "DATE": "19.04.2020 18:35:09",
            "MERCHANT_AMOUNT_TRANSFER_DETAIL": {
                "EXTRACT_ID": 5715,
                "SENDED_AMOUNT": "148,88",
                "SENDED_DATE": "4.05.2020 11:58:11"
            },
            "SUB_MERCHANT_DETAILS": [
                {
                    "EXTERNAL_ID": "999999",
                    "AMOUNT": "1073,00",
                    "DATE": "19.04.2020 18:35:09",
                    "SUB_MERCHANT_AMOUNT_TRANSFER_DETAIL": {
                        "EXTRACT_ID": 5779,
                        "SENDED_AMOUNT": "1073,00",
                        "SENDED_DATE": "4.05.2020 11:57:28"
                    }
                }
            ]
        }
    ]
}

İşlem durum sorgulama cevap mesajında işlem türü "Ödeme - Başarılı" ya da "İade - Başarılı" durumunda ise 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.

İşlem türü "İptal - Başarılı" ise STATUS parametresinin değeri ORDER_CANCEL ve RETURN_CODE parametresinin değeri 300 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_IDSTATUS_NAMEAçı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.

PreviousÜye İşyeri Bakiye Sorgulama ServisiNextİşlem Sorgulama Servisi - Detaylı

Last updated