Üye İşyeri(Alıcı) Talimat Oluştur

Bu API Üye işyerinin(Alıcı), müşterilerine(Borçlulara) talimat oluşturma işlemini gerçekleştirmektedir. İşlemin tamamlanması için Banka kanallarından(İnternet,Mobil Şube, Vinov App) Vinov Borçlusunun API üzerinden oluşturulan talimatı onaylaması gerekmektedir.

API Bilgileri

URL

/vinov/createInstruction

Metot

POST

Versiyon

1.0

Scope

payment

Yetkilendirme Yöntemi

b2b_credentials


Girdi Bilgileri

Alan Adı Format Açıklama Zorunlu/Opsiyonel

InstructionCreationType

Integer (1) Talimat oluşturma şekli
Tckn = 1, Vkn = 2, CepTelefonu = 3, QR = 4
Zorunlu

InstructionAmount

Decimal (26,2) Talimat tutarı Zorunlu

ExpiryDate

yyyy-MM-ddTHH24:mm:ss Vade tarihi
Taksit sayısı 2 ve üstünde ise alan boş gönderilmelidir.
Koşullu Zorunlu

PaymentPurpose

Integer (2) Ödeme amacı
KonutKirasiOdemesi = 1, IsYeriKirasiOdemesi = 2, DigerKiraOdemesi = 3,
EticaretOdemesi = 4, CalisanOdemesi = 5, TicariOdeme = 6, BireyselOdeme = 7,
Yatirim = 8, Finansal = 9, EgitimOdemesi = 10, AidatOdemesi = 11, Diger = 99
Zorunlu

WorkPlaceId

Integer (19) İşyeri id
Firmaya Vinov işyeri tanım esansında verilen benzersiz değerdir.
Zorunlu

NumberofInstallments

Integer (3) Taksit sayısı
Taksitli işlemi yapılmayacak ise alan değeri 1 gönderilmelidir. Taksitli işlem yapılacak ise alan değeri 2 ve üstünde iletilmelidir.
Zorunlu

IdentityTaxNumber

String (11) Borçlu tckn veya vkn
Talimat oluşturma şekli 1 ve 2 ise dolu olacaktır. Diğer durumlarda boş iletilmelidir. Talimat oluşturma şekli 1 ise 11 hane iletilmelidir. Talimat oluşturma şekli 2 ise 10 hane iletilmelidir.
Koşullu Zorunlu

PhoneNumber

String (10) Borçlu cep telefonu
Talimat oluşturma şekli 3 ise dolu olmalıdır. Başına 0 eklenmeden iletilmelidir.
Koşullu Zorunlu

SellerProductCode

String (50) Satıcı Urun Kodu Opsiyonel

DealerNumber

String (100) Bayi No Opsiyonel

InvoiceNumber

String (50) Fatura No Opsiyonel

InstructionDescription

String (1000) Talimat Açıklaması Opsiyonel

CustomerNumber

String (12) Borçlı müşteri numarası
Alıcı Tckn Vkn / Alıcı Cep Telefon bilgisine ait Vinov tanımlı birden fazla müşteri var ise bu alan dolu olmalıdır.
Opsiyonel

IdentityNumber

String (11) Öğrenci TC Kimlik Numarası Opsiyonel

FirstMaturityDate

yyyy-MM-ddTHH24:mm:ss İlk vade tarihi
Taksit sayısı 2 ve üstünde ve ödeme plan alanı boş ise ilk vade tarihi gönderilebilir. Ödeme Plan alanı gönderilmediği durumda gönderilmelidir.
Koşullu Zorunlu

InstallmentPlan

List Esnek ödeme planı
Taksit sayısı 2 ve üstünde olduğu durumda ödeme planı gönderilebilir.
Girilen ödeme plan toplam tutarı ile talimat tutar alanı, ödeme plan taksit adetleri ile de taksit sayısı eşit olmalıdır.
İlk Vade Tarihi gönderilmediği durumda gönderilmesi beklenmektedir.
Koşullu Zorunlu

List< InstallmentPlan >

Alan Adı Format Açıklama Zorunlu/Opsiyonel

DebtAmount     

Decimal (26,2) Borç tutarı
Ödeme planı borç tutarı      
Koşullu Zorunlu

MaturityDate

yyyy-MM-ddTHH24:mm:ss Vade tarihi
Ödeme planı vade tarihi
Koşullu Zorunlu


Çıktı Bilgileri

Result

Alan Adı Format Açıklama

IsSucceeded

Bool İşlem başarılı ise alan True gelecek, hatalı ise false gelecektir.

Id

Integer (19) İşlem başarılı ise dolu gelecektir.

QRCodeText

String (1000) Talimat oluşturma şekli 4 ise alan dolu gelecektir.

List< FeeInfo >

Alan Adı Format Açıklama

FeeType

Integer Masraf tipi
None = 0, Limit = 1, VgoOlusturmaUcreti = 2, BorcluGarantilemeKomisyon = 3, AlacakliGarantilemeKomisyon = 4, Alacakli(Isyeri)Islemucreti = 5

FeeAmount

Decimal Masraf tutarı


Mesaj Kodları

Mesaj Kodu Açıklama

ACBH000085

Ödeme amacı alanına geçersiz bir değer girildi.

ACBH000101

T.C. kimlik numarası boş bırakılamaz.

ACBH000146

T.C. kimlik numarası uygun formatta girilmelidir.

ACBH000365

Vergi Kimlik Numarası boş bırakılamaz.

ACBH000267

Vergi kimlik numarası uygun formatta girilmelidir.

ACBH000366

Cep telefonu numarası boş bırakılamaz.

ACBH000212

Cep telefonu 10 hane olmalı ve 5 ile başlamalıdır.

ACBH000466

Talimat oluşturma tipi alanına geçersiz bir değer girildi.

ACBH000467

Vade Tarihi boş olamaz.

ACBH000468

Vade Tarihi uygun formatta girilmelidir.

ACBH000237

Müşteri numarası uygun formatta girilmelidir.

ACBH000854

Taksit planı ile taksit sayısı uyuşmamaktadır.

Örnek

İstek:

{
    "InstructionCreationType": 1,
    "IdentityTaxNumber": "1",
    "CustomerNumber": "1",
    "InstructionAmount": 1200.5,
    "NumberofInstallments": 2,
    //"ExpiryDate": "2024-08-07T00:00:00",
    "PaymentPurpose": 10,
    "WorkPlaceId": 111005,
    "SellerProductCode": "",
    "DealerNumber": "",
    "InvoiceNumber": "23331312017",
    "InstructionDescription": "",
    "IdentityNumber": "",
    "FirstMaturityDate": "",
    "InstallmentPlan": [
        {
            "DebtAmount": 600.5,
            "MaturityDate": "2024-09-23T00:00:00+03:00"
        },
        {
            "DebtAmount": 600,
            "MaturityDate": "2024-09-23T00:00:00+03:00"
        }
    ]
}

Cevap:

{
    "Header": {
        "StatusCode": "APIGW000000",
        "StatusDescription": "Tamamlandı",
        "StatusDescriptionEn": "Completed",
        "ObjectID": "36788ffa-a01e-408e-b95b-d1257b0c3f91"
    },
    "Data": {
        "Result": {
            "IsSucceeded": true,
            "Id": 357106
        }
    }
}