Vomsis API

Vomsis API Geliştirici Portalı'na Hoş Geldiniz...

Geliştirici Portalı, Vomsis API'lerini kullanarak uygulama oluşturmanıza olanak sağlar. İlk uygulamaya başlamanız için ihtiyacınız olan her şeyi sağladık. Yetkilendirme ve API Kullanımı bölümlerini içeren aşağıdaki kılavuza göz atmanızı öneririz.

Vomsis API KEY ve SECRET nasıl oluşturulur?

Vomsis panel üzerinden, API Ayarları sayfası ile yeni api uygulaması oluşturabilirsiniz. Oluşturulan api uygulaması detayından otomatik oluşturulan API KEY ve SECRET değerlerini alabilirsiniz. Uygulama oluştururken girdiğiniz statik ip adresi üzerinden isteklerde bulunabileceğinizi unutmayın.

Not Servisleri çağırabileceğiniz çalışma aralığı 5 dakikadır.

Postman Collections

Servislerin kullanırken Postman koleksiyonlarından yardım alabilir örnek kod çıktıları ile servisleri projelerinize hızlıca adapte edebilirsiniz. Dökümana aşağıdaki link üzerinden ulaşabilirsiniz.

https://documenter.getpostman.com/view/1546119/T1DwctfK?version=latest

Authentication - User Authentication

POST https://developers.vomsis.com/api/v2/authenticate

Params

Field	Type	Description
app_key	String	Api Key
app_secret	String	Api Secret

Response Parameters

Field	Type	Description
status	String	Servis durumu
token	String	Her istekte gönderilecek olan anahtar

Response

{
    "status": "success",
    "token": "eyJ0eXAiOiJKV1QiLCJhbGcasiOiJSUzI1NiIsImp0aSI6ImI5ZjhiY2RmZmQ1MzMxYTliMmI4NDcwMzIwZTIwMmZkMjhjMzNlMzdhOTE3OTI1OWNlNjNmYWEzNzc3YmViZDllYjEyZmY2MGE1OWU3NDExIn0.eyJhdWQiOiI3IiwianRpIjoiYjlmOGJjZGZmZDUzMzFhOWIyYjg0NzAzMjBlMjAyZmQyOGMzM2UzN2E5MTc5MjU5Y2U2M2ZhYTM3NzdiZWJkOWViMTJmZjYwYTU5ZTc0MTEiLCJpYXQiOjE1NzQ2NjI5NDYsIm5iZiI6MTU3NDY2Mjk0NiwiZXhwIjoxNjA2Mjg1MzQ2LCJzdWIiOiIxOTgiLCJzY29wZXMiOltdfQ.F8l2XZ2W3S1XPY3ql9fLX49kIdVh9kw8D7mwn2RFJMaGaJHN15k24NczOqkCSgzLOcGwf77Qm1jpu4zP-R7ZKd6N3rUgc288_GyiWi2xdbBMNctF8mIihZTpLkFiupr9mP7UlkdfgwgOPdIj8ZDF207edVwnZHORRz9a8jUbofF9_ykLC5xhYeuD3ZRt-XJsgQsjv4FL-Fj0k-AFu_XVPaG0_9T7yQAztKMppTJgaPMwmuOJCFtccdBpPncdcRi5QPTtJ6cQzr75seTmuP_n7HAMfEjEgB6ElJztWBIODJn5ale2tSwFvo9-0y1-7-JYxKDzXCnLU7vuEMdOI_FeY6gQtHp3WAjdU7pLQj-DEaS-CE3HnOeTZtNbBLfpDq8W4oW4_Hr2uFY41EEIjmXzeIXN7Ctn2dFKeUvhJbt0XVkVLvg2Eh4s-hdW0HWyWX_E9d6NPVdNQd_Kuzd9XKcAUBCiJMo_SrsaaEBhiEM4fOoWeR3AYHT1GDZUmFZDbaPAuSvrXLFPqYruqbhudtIj71BvROca47TPUBWkmmVvGzEQMEtl8N3SHJUFwq_x-CcTWwI48yM4iXFtxlGpQl1HlItmyd5CSIApGlSSKyDEsAfJNj7VBlpj82gkMRAuje7uqOOXwJHSZ8v58Zd8B2BWaYSnV63NONIFpwR_yNQ5jnY"
}

Bank Lists

GET https://developers.vomsis.com/api/v2/banks

Headers

Field	Type	Description
Authorization	String	Bearer {access_token}

Response Parameters

Field	Type	Description
id	Int	Banka benzersiz id değeri
bank_name	String	Banka benzersiz değeri
bank_title	String	Banka adı
order	Int	Banka listeleme sırası
created_at	Datetime	Vomsis tarafından kayıt eklenme tarihi

Response

{
    "status": "success",
    "banks": [
        {
            "id": 5,
            "bank_name": "finansbank",
            "bank_title": "QNB Finansbank",
            "order": 1,
            "created_at": "2022-10-19 17:46:28"
        }
    ]
}

Account Lists

GET https://developers.vomsis.com/api/v2/accounts

Headers

Field	Type	Description
Authorization	String	Bearer {access_token}

Response Parameters

Field	Type	Description
id	Int	Hesap benzersiz id değeri
bank_id	Int	Banka benzersiz id değeri
branch_name	String	Hesap kanal adı
fec_name	String	Para birimi
account_number	Int	Hesap numarası
balance	Float	Hesap bakiyesi
branch_id	Int	Hesap kanal id
add_to_balance	Int	Tüm banka hesapları toplamına dahil et/etme 1-0 değerini alır. Dahil Et(1)
custom_iban	String	Müşteri tarafından belirlenen iban adresi
iban	String	Hesap iban adresi
status	Int	Hesap aktif/pasif durumu
b_order	Int	Hesap listeleme sırası
product_code	String	Hesap türü
created_at	Datetime	Vomsis tarafından kayıt oluşturulma tarihi

Response

{
    "status": "success",
    "accounts": [
        {
            "id": 38,
            "bank_id": 19,
            "branch_name": null,
            "fec_name": "TL",
            "account_number": "3123647",
            "balance": "8598.70",
            "branch_id": "115",
            "add_to_balance": 1,
            "custom_iban": null,
            "iban": "TR440020300003643647123401",
            "status": 1,
            "b_order": 0,
            "product_code": "CARIHSP",
            "created_at": "2020-09-30 09:03:44"
        }
    ]
}

Bank Account Lists

GET https://developers.vomsis.com/api/v2/banks/{id}/accounts

Headers

Field	Type	Description
Authorization	String	Bearer {access_token}

Response Parameters

Field	Type	Description
id	Int	Hesap benzersiz id değeri
branch_name	String	Banka kanal adı
fec_name	String	Para birimi
account_number	Int	Hesap numarası
balance	Float	Hesap bakiyesi
branch_id	Int	Hesap kanal id
add_to_balance	Int	Tüm banka hesapları toplamına dahil et/etme 1-0 değerini alır. Dahil Et(1)
custom_iban	String	Müşteri tarafından belirlenen iban adresi
iban	String	Hesap iban adresi
status	Int	Hesap aktif/pasif durumu
b_order	Int	Hesap listeleme sırası
product_code	String	Hesap türü
created_at	Datetime	Vomsis tarafından kayıt oluşturulma tarihi

Response

{
    "status": "success",
    "banks": [
        {
            "id": 24,
            "branch_name": "",
            "fec_name": "TL",
            "account_number": "1800225",
            "balance": "98481.00",
            "branch_id": "828",
            "add_to_balance": 1,
            "custom_iban": null,
            "iban": "TR775749619066252661823960",
            "status": 1,
            "b_order": 2,
            "product_code": null,
            "created_at": "2019-06-13 14:36:03"
        }
    ]
}

Account Detail

GET https://developers.vomsis.com/api/v2/accounts/{id}

Headers

Field	Type	Description
Authorization	String	Bearer {access_token}

Response Parameters

Field	Type	Description
id	Int	Hesap benzersiz id değeri
branch_name	String	Banka kanal adı
fec_name	String	Para birimi
account_number	Int	Hesap numarası
balance	Float	Hesap bakiyesi
branch_id	Int	Hesap kanal id
add_to_balance	Int	Tüm banka hesapları toplamına dahil et/etme 1-0 değerini alır. Dahil Et(1)
custom_iban	String	Müşteri tarafından belirlenen iban adresi
iban	String	Hesap iban adresi
status	Int	Hesap aktif/pasif durumu
b_order	Int	Hesap listeleme sırası
product_code	String	Hesap türü
created_at	Datetime	Vomsis tarafından kayıt oluşturulma tarihi

Response

{
    "status": "success",
    "account": [
        {
            "id": 25,
            "branch_name": "",
            "fec_name": "EUR",
            "account_number": "1689894",
            "balance": "557.00",
            "branch_id": "885",
            "add_to_balance": 1,
            "custom_iban": null,
            "iban": "TR006088489122042702190239",
            "status": 1,
            "b_order": 1,
            "product_code": null,
            "created_at": "2019-06-13 14:36:03"
        }
    ]
}

Account Transactions

GET https://developers.vomsis.com/api/v2/accounts/{id}/transactions

Headers

Field	Type	Description
Authorization	String	Bearer {access_token}

Query Params

Field	Type	Description
beginDate	String	Hareket başlangıç tarihi ör. 05-11-2019 00:00:00
endDate	String	Hareket başlangıç tarihi ör. 06-11-2019 00:00:00
lastId	Int	Belirtilen ID üzerindeki hareketleri getirir. (Opsiyonel)
dateType	String	Muhasebe veya sistem tarihine göre listeleme yapar. [system_date,accounting_date] (Opsiyonel)
types	String	Hareket tiplerine göre kayıtları getirir. /api/v2/transaction_types servisinden değerler alınabilir.(Opsiyonel)

Response Parameters

Field	Type	Description
id	Int	Hareket benzersiz id değeri
vms_transaction_type	String	Vomsis tarafından belirlenen hareket tipi
bank_account_id	Int	Bağlı olduğu hesap benzersiz id değeri
transaction_type	String	Hareket kodu
mt940transaction_type	String	MT940 hareket kodu
system_date	Datetime	Banka hareket oluşturulma tarihi
accounting_date	Datetime	Banka hareket muhasebe tarihi
sender_identity_number	String	Gönderen tckn
sender_name	String	Gönderen ad soyad
sender_branch	String	Gönderen hesap no
sender_title	String	Gönderen ünvan
sender_iban	String	Gönderen iban
sender_taxno	String	Gönderen vkn
reciever_iban	String	Alıcı iban
opponent_title	String	Karşı taraf ünvan
opponent_iban	String	Karşı taraf iban
opponent_taxno	String	Karşı taraf vkn
fis_no	String	Fis numarası
payer_tax_no	String	Ödeyen vkn
description	String	Hareket açıkmala
fec_name	String	Para birimi
amount	Float	Tutar
current_balance	Float	Anlık bakiye
resource_code	String	Evrak numarası
type	String	Banka hareket turu [borclu,alacakli]
note	String	Vomsis panelinde, kullanıcılar tarafından verilen açıklama
order	String	Hareket sırası
created_at	Datetime	Vomsis tarafından kayıt oluşturulma tarihi
tags	Array	Vomsis panelinde, kullanıcılar tarafından verilen etiketler [ { "tag_id": 2, "detail_id": 615745, "tag": { "id": 2, "name": "Virman" } } ]

Response

{
    "status": "success",
    "transactions": [
        {
            "id": 6915745,
            "vms_transaction_type": "VIRMGID",
            "bank_account_id": 73,
            "key": "23b9e3f191a286d7a934a22b8a9decd1",
            "transaction_type": "EFT",
            "mt940transaction_type": "EFT",
            "system_date": "2022-03-10 13:50:45",
            "accounting_date": "2022-03-10 13:50:45",
            "sender_identity_number": null,
            "sender_name": null,
            "sender_branch": null,
            "sender_title": "",
            "sender_iban": "TR940013500000007906321001",
            "sender_taxno": "3230491123",
            "reciever_iban": null,
            "opponent_title": "",
            "opponent_iban": "TR940013500000007906080001",
            "opponent_taxno": "3230491123",
            "fis_no": "9300202203100023238027",
            "payer_tax_no": null,
            "description": "SN:58689 Vomsis A.Ş. Açk: DNZ AND EFT 107322 209000.00 TRY Gönd.",
            "fec_name": "TL",
            "amount": "-209000.00",
            "current_balance": "2424.45",
            "resource_code": "9300202203100005898027",
            "type": "borclu",
            "note": null,
            "order": 1,
            "created_at": "2022-03-10 13:51:58",
            "tags": [
                {
                    "tag_id": 2,
                    "detail_id": 615745,
                    "tag": {
                        "id": 2,
                        "name": "Virman"
                    }
                }
            ]
        }
    ]
}

Transactions

GET https://developers.vomsis.com/api/v2/transactions

Headers

Field	Type	Description
Authorization	String	Bearer {access_token}

Query Params

Field	Type	Description
beginDate	String	Hareket başlangıç tarihi ör. 05-11-2019 00:00:00
endDate	String	Hareket başlangıç tarihi ör. 06-11-2019 00:00:00
lastId	Int	Belirtilen ID üzerindeki hareketleri getirir. (Opsiyonel)
dateType	String	Muhasebe veya sistem tarihine göre listeleme yapar. [system_date,accounting_date] (Opsiyonel)
types	String	Hareket tiplerine göre kayıtları getirir. /api/v2/transaction_types servisinden değerler alınabilir.(Opsiyonel)
bankName	String	İlgili bankaya ait hareketleri getirir. /api/v2/banks servisinden bank_name değerleri gönderilmelidir. (Opsiyonel)

Response Parameters

Field	Type	Description
id	Int	Hareket benzersiz id değeri
vms_transaction_type	String	Vomsis tarafından belirlenen hareket tipi
bank_account_id	Int	Bağlı olduğu hesap benzersiz id değeri
transaction_type	String	Hareket kodu
mt940transaction_type	String	MT940 hareket kodu
system_date	Datetime	Banka hareket oluşturulma tarihi
accounting_date	Datetime	Banka hareket muhasebe tarihi
sender_identity_number	String	Gönderen tckn
sender_name	String	Gönderen ad soyad
sender_branch	String	Gönderen hesap no
sender_title	String	Gönderen ünvan
sender_iban	String	Gönderen iban
sender_taxno	String	Gönderen vkn
reciever_iban	String	Alıcı iban
opponent_title	String	Karşı taraf ünvan
opponent_iban	String	Karşı taraf iban
opponent_taxno	String	Karşı taraf vkn
fis_no	String	Fis numarası
payer_tax_no	String	Ödeyen vkn
description	String	Hareket açıkmala
fec_name	String	Para birimi
amount	Float	Tutar
current_balance	Float	Anlık bakiye
resource_code	String	Evrak numarası
type	String	Banka hareket turu [borclu,alacakli]
note	String	Vomsis panelinde, kullanıcılar tarafından verilen açıklama
order	String	Hareket sırası
created_at	Datetime	Vomsis tarafından kayıt oluşturulma tarihi
tags	Array	Vomsis panelinde, kullanıcılar tarafından verilen etiketler [ { "tag_id": 2, "detail_id": 615745, "tag": { "id": 2, "name": "Virman" } } ]
account	account	Hareketin bağlı olduğu Hesap ve Banka bilgisi { "id": 73, "bank_id": 22, "branch_name": "Yedi̇tepe Büyük İşletmeler", "fec_name": "TL", "account_number": "2913129", "balance": "1732.25", "branch_id": "4840", "iban": "TR700013400000291312900004", "custom_iban": null, "status": 1, "b_order": 0, "product_code": "VDSZMVD" "bank": { "id": 22, "bank_name": "denizbank", "bank_title": "Denizbank", "order": 6 } }

Response

{
    "status": "success",
    "transactions": [
        {
            "id": 6915745,
            "vms_transaction_type": "VIRMGID",
            "bank_account_id": 73,
            "key": "23b9e3f191a286d7a934a22b8a9decd1",
            "transaction_type": "EFT",
            "mt940transaction_type": "EFT",
            "system_date": "2022-03-10 13:50:45",
            "accounting_date": "2022-03-10 13:50:45",
            "sender_identity_number": null,
            "sender_name": null,
            "sender_branch": null,
            "sender_title": "",
            "sender_iban": "TR940013500000007906321001",
            "sender_taxno": "3230491123",
            "reciever_iban": null,
            "opponent_title": "",
            "opponent_iban": "TR940013500000007906080001",
            "opponent_taxno": "3230491123",
            "fis_no": "9300202203100023238027",
            "payer_tax_no": null,
            "description": "SN:58689 Vomsis A.Ş. Açk: DNZ AND EFT 107322 209000.00 TRY Gönd.",
            "fec_name": "TL",
            "amount": "-209000.00",
            "current_balance": "2424.45",
            "resource_code": "9300202203100005898027",
            "type": "borclu",
            "note": null,
            "order": 1,
            "created_at": "2022-03-10 13:51:58",
            "tags": [
                {
                    "tag_id": 2,
                    "detail_id": 615745,
                    "tag": {
                        "id": 2,
                        "name": "Virman"
                    }
                }
            ],
            "account": {
                "id": 73,
                "bank_id": 22,
                "branch_name": "Yedi̇tepe Büyük İşletmeler",
                "fec_name": "TL",
                "account_number": "2913129",
                "balance": "1732.25",
                "branch_id": "4840",
                "iban": "TR700013400000291312900004",
                "custom_iban": null,
                "status": 1,
                "b_order": 0,
                "product_code": "VDSZMVD"
                "bank": {
                    "id": 22,
                    "bank_name": "denizbank",
                    "bank_title": "Denizbank",
                    "order": 6
                }
            }
        }
    ]
}

Terminal Lists

GET https://developers.vomsis.com/api/v2/pos-rapor/stations

Headers

Field	Type	Description
Authorization	String	Bearer {access_token}

Response Parameters

Field	Type	Description
id	Int	Terminal benzersiz id değeri
bank_name	String	Banka benzersiz değeri
bank_title	String	Banka adı
status	Int	Pos aktif/pasif durumu. Aktif(1)
workplace_no	Int	İşyeri no
station_no	Int	Pos no
workplace_name	String	İşyeri adı
transaction_currency	String	Para birimi
custom_name	String	Vomsis panelinde, kullanıcı tarafından verilen değer
commission_rate	Float	Tek çekim komisyon oranı

Response

{
    "success": "true",
    "data": [
        {
            "id": 1,
            "bank_name": "garanti",
            "bank_title": "Garanti",
            "status": 1,
            "workplace_no": "0123456",
            "station_no": "0123456",
            "workplace_name": "VOMSIS",
            "transaction_currency": "TL",
            "custom_name": "VOMSIS",
            "commission_rate": "0.00"
        }
    ]
}

Terminal Transactions

GET https://developers.vomsis.com/api/v2/pos-rapor/stations/{id}/transactions

Headers

Field	Type	Description
Authorization	String	Bearer {access_token}

Response Parameters

Field	Type	Description
id	Int	Hareket benzersiz id değeri
award_contribution	String	Ödül katkısı
batchn	String	Batch no
blocked_date	String	Bloke tarihi
blocked_no	Int	Bloke no
block_time	String	Bloke saat
card_number	String	Kredi kartı numarası
card_type	String	Kart tipi
chain_no	String
commission	Float	Komisyon
commission_rate	Float	Komisyon oranı
confirmation_number	String	Doğrulama kodu
date	Date	Tarih
description	String	Açıklama
end_of_day_date	Date	Gün sonu tarihi
exchange	String	Döviz cinsi
extra_award_contribution	String	Ekstra ödül katkısı
gross_amount	Float	Bürüt tutar
iklcom_chip	Stringg	-
installments_count	Int	Taksit sayısı
installments_order	Int	Taksit sırası
kesilen_chip	String	-
key	String	Hareket benzersiz anahtar
net_amount	Float	Net tutar
net_chip	String	-
product_class	String	Ürün sınıfı
provision_date	Date	Provizyon tarihi
provision_no	String	Provizyon no
reference_number	String	Referans numarası
registration_date	Date	Kayıt tarihi
registration_date	Date	Kayıt tarihi
service_com	String	-
sm_award_contribution	String	-
station	String	İstasyon
station	String	İstasyon
sub_card_type	String	Kart tipi
system_date	Datetime	Sistem kayıt tarihi
time	Time	Sistem kayıt saati
transaction_end_date	Date	İşlem bitiş tarihi
transaction_no	String	İşlem no
transaction_type	String	İşlem tipi
transfer_to_account_date	Date	Hesap aktarma tarihi
valor	Date	Valör tarihi
vrcom_chip	String	-
workplace	String	İşyeri
workplace_social_contribution	String	İşyeri sosyal katkı

Query Params

Field	Type	Description
beginDate	String	Hareket başlangıç tarihi ör. 05-11-2021 - Tarih aralığı max. 14 gün olabilir.
endDate	String	Hareket başlangıç tarihi ör. 06-11-2021 - Tarih aralığı max. 14 gün olabilir.
lastId(Opsiyonel)	Integer	Belirtilen ID üzerindeki hareketleri getirir.

Response

{
    "status": "success",
    "transactions": [
        {
            "id": 41789,
            "award_contribution": null,
            "batchn": null,
            "blocked_date": null,
            "blocked_no": null,
            "block_time": null,
            "card_number": "1234********6789",
            "card_type": null,
            "chain_no": null,
            "commission": "0.00",
            "commission_rate": "0.00",
            "confirmation_number": "123456",
            "date": "01.12.2021",
            "description": "PESIN YD KART",
            "end_of_day_date": "2021-12-01",
            "exchange": "EUR",
            "extra_award_contribution": null,
            "gross_amount": "123.00",
            "iklcom_chip": null,
            "installments_count": 0,
            "installments_order": 0,
            "kesilen_chip": null,
            "key": "c91e3dc9d21bd1f13f29dd48e86589a9",
            "net_amount": "123.00",
            "net_chip": null,
            "product_class": null,
            "provision_date": null,
            "provision_no": null,
            "reference_number": null,
            "registration_date": "01.12.2021",
            "service_com": null,
            "sm_award_contribution": null,
            "station": "VMS12345",
            "sub_card_type": "MASTERCARD",
            "system_date": "2021-12-01 23:48:20",
            "time": "23.48.20",
            "transaction_end_date": null,
            "transaction_no": null,
            "transaction_type": "Satış",
            "transfer_to_account_date": null,
            "valor": "02.12.2021",
            "vrcom_chip": null,
            "workplace": "12345678",
            "workplace_social_contribution": null
        }
    ]
}