İşlem Sorgulama Servisi - Detaylı

İşlem Durum Sorgulama Servisi İstek Modeli;

Metod

API URL

Parametreler

POST

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

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.

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

Parametre

Tip

Zorunlu

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

paymentList

class

Evet

Detay bilgilerinin geleceği nesnedir.

PAYMENTLIST

Parametre

Tip

Zorunlu

Açıklama

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_NAME

string

Evet

Üye iş isim bilgisidir.

DEALER_CODE

long?

Evet

Üye iş yerine özel oluşturulan eşsiz kod bilgisidir.

INSERT_DATETIME

DateTime

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

decimal

Evet

Ödeme işlemine ait miktar bilgisidir.

COMMISSION_AMOUNT

decimal?

Evet

Komisyon miktarı bilgisidir.

DEALER_PAYMENT_REF_CODE

string

Evet

Üye iş yeri ödeme referans kod bilgisidir.

COMMISSION_RATE

decimal?

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

bool?

Evet

İptal isteği olup olmadığı bilgisidir.

STATUS_ID

int?

Evet

Durum id bilgisidir.

JSONDATE

string

Evet

Json tarih bilgisidir.

NEED_FILES

bool

Evet

Dosya gerekliliği bilgisidir.

CONFIRM_FILES

bool

Evet

Onay durum bilgisidir.

INSERT_BY

string

Evet

Ekleyen kişi bilgisidir.

CHECK_INSERT_DATETIME

DateTime?

Evet

Kontol tarihi 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.

DEALER_RESPONSE_URL

string

Evet

Üye işyeri için response url bilgisidir.

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.

TRANSACTIONS

array

Evet

Ödeme işlemine ait gerçekleşen tüm işlem hareketlerine ait hareket detaylarını içeren Json nesne dizisidir.

PRODUCTS

array

Evet

Ürün liste bilgisidir.

TRANSACTION

Parametre

Tip

Zorunlu

Açıklama

TRANSACTION_ID

string

Evet

Alt işlem hareketine ait benzersiz id bilgisidir.

STATUS_NAME

string

Evet

Alt işlem hareketine ait durum bilgisidir.

STATUS_ID

int

Evet

Status 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

class

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

class

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.

PRODUCTS

Parametre

Tip

Zorunlu

Açıklama

int

Evet

ID bilgisidir.

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.

Gönderilen istek sonrası dönecek cevap bilgisi aşağıdaki gibidir;

{
    "paymentList": {
        "ID": 150838,
        "MERCHANT": "TEST1234",
        "DEALERID": 79,
        "DEALER_NAME": "Esnekpos Test",
        "DEALER_CODE": 79,
        "INSERT_DATETIME": "/Date(1595848596993)/",
        "CARD_TYPE": "VISA",
        "CARD_NUMBER": "453144******2283",
        "CARD_NAME": "deneme",
        "CARD_BANK_NAME": "halk",
        "CARD_FAMILY": "Paraf",
        "CURRENCY": "TRY",
        "VIRTUALPOS_NAME": "İş Bankası",
        "STATUS_NAME": "Ödeme - Başarılı",
        "INSTALLMENT": 1,
        "AMOUNT": 29.99,
        "COMMISSION_AMOUNT": 0.8997000,
        "DEALER_PAYMENT_REF_CODE": "0.54251300 1595848596|93",
        "COMMISSION_RATE": 0.03000,
        "CUSTOMER_NAME": "DENEME DENEME",
        "CUSTOMER_GSM": "05325257315",
        "USER_NAME": null,
        "CANCEL_REQUEST": true,
        "STATUS_ID": 3,
        "JSONDATE": null,
        "NEED_FILES": false,
        "CONFIRM_FILES": false,
        "INSERT_BY": null,
        "CHECK_INSERT_DATETIME": null,
        "JSONPAYMENT": null,
        "CC_HASH": "7f1dcf965c7f93298d004045c93e1cb11c8ee768dd6566a83b95b80771726db6",
        "PAYMENT_BANK_CODE": null,
        "DEALER_RESPONSE_URL": "https://unomodoeu.com/index.php?route=extension/payment/esnekpos_payment",
        "PAYMENT_WAY": "Virtual Pos",
        "PHYSICAL_POS_TITLE": "",
        "PHYSICAL_POS_ID": 0,
        "TRANSACTIONS": [
            {
                "TRANSACTION_ID": 435488,
                "STATUS_NAME": "Ödeme - Bekliyor",
                "STATUS_ID": 1,
                "AMOUNT": "-29,99",
                "DATE": "27.07.2020 14:16:36",
                "MERCHANT_AMOUNT_TRANSFER_DETAIL": null,
                "SUB_MERCHANT_DETAILS": null
            },
            {
                "TRANSACTION_ID": 435489,
                "STATUS_NAME": "Ödeme - 3D Doğrulama Bekleniyor",
                "STATUS_ID": 2,
                "AMOUNT": "-29,99",
                "DATE": "27.07.2020 14:16:37",
                "MERCHANT_AMOUNT_TRANSFER_DETAIL": null,
                "SUB_MERCHANT_DETAILS": null
            },
            {
                "TRANSACTION_ID": 435490,
                "STATUS_NAME": "Ödeme - Başarılı",
                "STATUS_ID": 3,
                "AMOUNT": "29,99",
                "DATE": "27.07.2020 14:16:45",
                "MERCHANT_AMOUNT_TRANSFER_DETAIL": null,
                "SUB_MERCHANT_DETAILS": null
            },
            {
                "TRANSACTION_ID": 435495,
                "STATUS_NAME": "İptal - Başarısız",
                "STATUS_ID": 6,
                "AMOUNT": "-29,99",
                "DATE": "27.07.2020 17:55:30",
                "MERCHANT_AMOUNT_TRANSFER_DETAIL": null,
                "SUB_MERCHANT_DETAILS": null
            },
            {
                "TRANSACTION_ID": 435496,
                "STATUS_NAME": "İade - Başarısız",
                "STATUS_ID": 8,
                "AMOUNT": "-29,99",
                "DATE": "28.07.2020 09:07:25",
                "MERCHANT_AMOUNT_TRANSFER_DETAIL": null,
                "SUB_MERCHANT_DETAILS": null
            }
        ],
        "PRODUCTS": []
    },
    "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

Ödeme - Başarılı

Başarılı olarak gerçekleşmiş ödemelerin ve alt işlemlerin sonucuda dönen durum bilgisidir.

Ödeme - Başarısız

Başarısız olarak gerçekleşmiş ödemelerin ve alt işlemlerin sonucuda dönen durum bilgisidir.

İptal - Başarılı

Başarılı olarak gerçekleşmiş iptal ödemelerin ve alt işlemlerin sonucuda dönen durum bilgisidir.

İptal - Başarısız

Başarısız olarak gerçekleşmiş iptal ödemelerin ve alt işlemlerin sonucuda dönen durum bilgisidir.

İade - Başarılı

Başarılı olarak gerçekleşmiş iade ödemelerin ve alt işlemlerin sonucuda dönen durum bilgisidir.

İ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İşlem Sorgulama Servisi NextTransfer Listeleme Servisi

Last updated 6 months ago