TOS İşlemleri Yap

TOS aracılığı ile ödeme talimatlarının api gateway aracılığıyla gerçekleştirilmesi sağlanmaktadır. Anlık olarak gelen talimat kontrol edilerek ödeme işlemi gerçekleştirilir.

API Bilgileri

URL

/tos/payment

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 bilgisidir. Zorunlu

TransactionType

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

TaxIdentityCheck

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

CreditUse

 Bool İşlem sırasında kredi kullanımı bilgisidir. Zorunlu

Amount

 Decimal İşlem tutarıdır. Zorunlu

CurrencyType

 String İşlemin yapıldığı para birimidir. Zorunlu

SenderAccountNo

 String İşlemi yapan hesaptır. Zorunlu

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. Koşullu Zorunlu

ReceiverBankCode

 String Alıcı banka kodu Opsiyonel

ReceiverBranchCode

 String Alıcı şube kodu Opsiyonel

ReceiverNameSurname

 String Gönderimin yapıldığı ad/soyad.TransactionType alanı 2 ise bu alan dolu olacaktır. Koşullu Zorunlu

Explanation

 String İşlem açıklaması Opsiyonel

InstitutionTransactionCode

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

ReceiverAddress

 String Alıcı adres Opsiyonel

ReceiverTelephone

 String Alıcı telefon Opsiyonel

ReceiverIdentityNo

 String Alıcı TCKN Opsiyonel

ReceiverAdministrationTax

 String Alıcı vergi dairesi Opsiyonel

ReceiverTaxNo

 String Alıcı VKN Opsiyonel

ReceiverFatherName

 String Alıcı baba adı Opsiyonel

ReceiverEmail

 String Alıcı mail adres Opsiyonel

PaymentDate

 DateTime İşlem yapılacağı tarih Zorunlu

InstitutionPackageNo

 String Paket no Opsiyonel

ComingReturnPaymentDate

 String İade işlem tarihi Opsiyonel

ComingReturnTransactionQueryNo

 String İade sorgu numarası Opsiyonel

ChiefName

 String Amir isim bilgisidir. Opsiyonel

ChiefAccountNo

 String Amir hesap bilgisidir. Opsiyonel

ChiefIdentityNo

 String Amir kimlik numarasıdır. Opsiyonel

ChiefAdress

 String Amir adres numarasıdır. Opsiyonel

ChiefCountryCity

 String Amir ülke ve şehir bilgisidir. Opsiyonel

ChiefBirthPlace

 String Amir doğum yeri bilgisidir. Opsiyonel

ChiefBirthDate

 String Amir doğum tarihi bilgisidir. Opsiyonel

ChiefCustomerNo

 String Amir müşteri numarası bilgisidir. Opsiyonel


Çıktı Bilgileri

Query Result

Alan Adı Format Açıklama

InstitutionTaxNo

 String İşlemin yapılırken girilen id değeridir.

Result

 Bool Başarılı ise alan true gelecek, hatalı ise false gelecektir.

ErrorCode

 İnteger Başarılı ise alan true gelecek, hatalı ise false gelecektir.

ErrorExplanation

 String Hatanın açıklamasıdır.

TransactionObjectId

 String İşlem transaction id

TransactionQueryNo

 String İşlem sorgu numarası


Mesaj Kodları

Mesaj Kodu Açıklama

ACBH000645

 Kurum kodu boş olamaz.

ACBH000027

 Döviz kodu boş olamaz.

ACBH000619

 Kurum işlem id boş olamaz.

Örnek

İstek:

{
    "InstitutionCode": "0006624",
    "TransactionType": 1,
    "TaxIdentityCheck": true,
    "CreditUse": true,
    "Amount": 200.0,
    "CurrencyType": "TL",
    "SenderAccountNo": "0",
    "ReceivertAccountIbanNo": "0",
    "ReceiverBankCode": "0015",
    "ReceiverBranchCode": "",
    "ReceiverNameSurname": "Oktay",
    "Explanation": "",
    "InstitutionTransactionCode": "$guid",
    "ReceiverAddress": "",
    "ReceiverTelephone": "",
    "ReceiverIdentityNo": "",
    "ReceiverAdministrationTax": "",
    "ReceiverTaxNo": "",
    "ReceiverFatherName": "oktay",
    "ReceiverEmail": "",
    "PaymentDate": "2022-12-28T00:00:00",
    "InstitutionPackageNo": "",
    "ComingReturnPaymentDate": "",
    "ComingReturnTransactionQueryNo": "",
    "ChiefName": "",
    "ChiefAccountNo": "",
    "ChiefIdentityNo": "",
    "ChiefAdress": "",
    "ChiefCountryCity": "",
    "ChiefBirthPlace": "",
    "ChiefBirthDate": "",
    "ChiefCustomerNo": ""
}

Cevap:

{
    "Header": {
        "StatusCode": "APIGW000000",
        "StatusDescription": "Tamamlandı",
        "StatusDescriptionEn": "Completed",
        "ObjectID": "18c1fd2f-b997-41dc-bf9e-5e8caacdcecb"
    },
    "Data": {
        "QueryResult": {
            "TransactionObjectId": "2022000039254817",
            "ErrorExplanation": "Tahsil Edildi",
            "InstitutionTaxNo": "7e591df3-2f3c-4971-9682-9e4455b35b2f",
            "TransactionQueryNo": "7425301",
            "ErrorCode": 1,
            "Result": true
        }
    }
}