TOS İşlemleri Sorgula

Bu API ile girilen bilgiler doğrultusunda işlem özelinde ya da belirli bir tarihte belirli bir hesaptan gerçekleştirilen tüm işlemler de listelenmebilmektedir.

API Bilgileri

URL

/tos/query

Metot

 POST

Versiyon

 1.0

Scope

 payment

Yetkilendirme Yöntemi

 b2b_credentials


Girdi Bilgileri

Alan Adı Format Açıklama Zorunlu/Opsiyonel

InstitutionCode

 String TOS Kurum tanım işlemindeki kod girilmektedir. Zorunlu

InstitutionPackageNo

 String Paket numarasıdır. Opsiyonel

SenderAccountNo

 String İşlemi yapan hesap bilgisidir. Opsiyonel

InstitutionTransactionNo

 String İşlem özelinde gerçekleştirilen id değeridir. İşlemin çift olmaması bu alandan kontrol edilmektedir. Opsiyonel

TransactionQueryNo

 String İşlem numarası id değeridir. Opsiyonel

PaymentDate

 DateTime İşlem yapıldığı tarih bilgisidir. Opsiyonel

PaymentDate

 DateTime İşlem yapıldığı tarih bilgisidir. Opsiyonel

TransactionType

 Enum(ApiIslemTipleri) İşlem tipinin girildiği alandır.
None = 0
Hesaba = 1
Isme = 2
KrediKarti = 3
Iade = 5		 Opsiyonel

ReceivertAccountIbanNo

 String Alıcı hesap/iban.TransactionType alanı 3 ise ilgili alan bilgisi kredi kartı numarası olmalıdır.TransactionType alanı 2 ise bu alan boş olacaktır. Opsiyonel

ReturnDate

 DateTime İade işlem tarihi bilgisidir. Opsiyonel


Çıktı Bilgileri

Result

Alan Adı Format Açıklama

InstitutionCode

 String TOS Kurum tanım işlemindeki kod girilmektedir.

TransactionType

 Enum(ApiIslemTipleri) İşlem tipinin girildiği alandır.
None = 0
Hesaba = 1
Isme = 2
KrediKarti = 3
Iade = 5

TaxIdentityCheck

 Bool İşlem sırasında vergi/TCKN alan kontrolü belirlenmektedir.

CreditUse

 Bool İşlem sırasında kredi kullanımını belirlenmektedir.

Amount

 Decimal İşlem tutarı bilgisidir.

CurrencyType

 String İşlemin yapıldığı para birimi bilgisidir.

SenderAccountNo

 String İşlemi yapan hesap bilgisidir.

ReceivertAccountIbanNo

 String Alıcı hesap/iban bilgisidir.

ReceiverBankCode

 String Alıcı banka kodu bilgisidir.

ReceiverBranchCode

 String Alıcı şube kodu bilgisidir.

ReceiverNameSurname

 String Gönderimin yapıldığı ad soyad bilgisidir.

Explanation

 String İşlem açıklaması bilgisidir.

InstitutionTransactionCode

 String İşlem özelinde gerçekleştirilen id değeridir. İşlemin çift olmaması bu alandan kontrol edilmektedir.

ReceiverAddress

 String Alıcı adres bilgisidir.

ReceiverTelephone

 String Alıcı telefon bilgisidir.

ReceiverIdentityNo

 String Alıcı TCKN bilgisidir.

ReceiverAdministrationTax

 String Alıcı vergi dairesi bilgisidir.

ReceiverTaxNo

 String Alıcı VKN bilgisidir.

ReceiverFatherName

 String Alıcı baba adı bilgisidir.

ReceiverEmail

 String Alıcı mail adres bilgisidir.

PaymentDate

 DateTime İşlem yapılacağı tarih bilgisidir.

InstitutionPackageNo

 String Paket numarası bilgisidir.

ComingReturnPaymentDate

 DateTime İade işlem tarihi bilgisidir.

ComingReturnTransactionQueryNo

 String İade sorgu numarası bilgisidir.

ReceiverBankName

 String Alıcı banka adı bilgisidir.

ReturnTransactionObjectId

 String İade transaction id bilgisidir.

ReturnDate

 DateTime İade tarihi bilgisidir.

TransferDate

 DateTime İşlem tarihi bilgisidir.

ExtractExplanation

 String Ekstre açıklama bilgisidir.

TransactionObjectId

 String İşlem transaction id bilgisidir.

SenderBranchCode

 String Gönderen hesap şube kodu bilgisidir.

Result

 Bool İşlem sonuç bilgisidir.

ErrorCode

 Enum(HareketHataKodlari) HareketHataKodlari enum değerleri bilgisidir.

ErrorExplanation

 String Hata açıklaması bilgisidir.

TransactionQueryNo

 String İşlem sorgu numarası bilgisidir.

Result

 Bool İşlem sonuç bilgisidir.

ErrorCode

 Enum(HareketHataKodlari) HareketHataKodlari enum değerleri bilgisidir.

ErrorExplanation

 String Hata açıklaması bilgisidir.


Mesaj Kodları

Mesaj Kodu Açıklama

ACBH000645

 Kurum kodu boş olamaz.

Örnek

İstek:

{
    "InstitutionCode": "0006624",
    "InstitutionPackageNo": "",
    "SenderAccountNo": "0",
    "InstitutionTransactionNo": "",
    "TransactionQueryNo": "",
    "PaymentDate": "2022-12-28T00:00:00",
    "TransactionType": 1,
    "ReceivertAccountIbanNo": "",
    "ReturnDate": ""
}

Cevap:

{
    "Header": {
        "StatusCode": "APIGW000000",
        "StatusDescription": "Tamamlandı",
        "StatusDescriptionEn": "Completed",
        "ObjectID": "b6d2a25b-ddf9-4260-9aa5-a99307184567"
    },
    "Data": {
        "ListQueryResult": {
            "Result": "true"
        },
        "Result": {
            "TransactionType": 1,
            "TransactionObjectId": 2022000039254817,
            "InstitutionTransactionCode": "7e591df3-2f3c-4971-9682-9e4455b35b2f",
            "ReceiverBankCode": "0064",
            "PaymentDate": "2022-12-28T00:00:00",
            "ErrorExplanation": "BAŞARILI",
            "InstitutionCode": "0006624",
            "Amount": 200,
            "CreditUse": true,
            "SenderAccountNo": "0",
            "ReceiverNameSurname": "Oktay",
            "ReceiverBranchCode": 90001,
            "ReceiverFatherName": "oktay",
            "Result": true,
            "ReceiverBankName": "Türkiye İş Bankası",
            "TransactionQueryNo": 7425301,
            "TransferDate": "2022-12-28T11:49:07",
            "ErrorCode": 1,
            "CurrencyType": "TL"
        }
    }
}