Üye İşyeri(Alıcı) Talimat Listele

Bu API Üye işyerinin(Alıcı), müşterilerine(Borçlulara) oluşturulan talimatları listeleme işlemini gerçekleştirmektedir.

API Bilgileri

URL

/vinov/listInstruction

Metot

POST

Versiyon

1.0

Scope

payment

Yetkilendirme Yöntemi

b2b_credentials


Girdi Bilgileri

Alan Adı Format Açıklama Zorunlu/Opsiyonel

WorkPlaceId

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

Id

Integer(19) Üye İş Yeri Talimat Oluştur API'ının çıktısında dönen Id değeridir.
Bu alan girildi ise WorkPlaceId hariç tüm diğer alanlar opsiyoneldir.
VinovNumber alanı dolu ise Id alanı boş olmalıdır.
Koşullu Zorunlu

VinovNumber

Integer(19) Müşteri tarafından onaylanmış talimatın numarasıdır.
Bu alan girildi ise WorkPlaceId hariç tüm diğer alanlar opsiyoneldir.
ID alanı dolu ise VinovNumber alanı boş olmalıdır.
Koşullu Zorunlu

LimitStart

Decimal (26,2) Başlangıç limit bilgisidir.
Id veya VinovNo alanı girildiyse bu alan boş olmalıdır.
Koşullu Zorunlu

LimitEnd

Number(26,2) (19) Bitiş limit bilgisidir.
Id veya VinovNo alanı girildiyse bu alan boş olmalıdır.
Koşullu Zorunlu

ExpiryStartDate

yyyy-MM-ddTHH24:mm:ss Vade Başlangıç Tarihi bilgisidir.
Id, VinovNumber, InstructionStartDate ve InstructionEndDate alanları boş ise bu alan Zorunludur.
Koşullu Zorunlu

ExpiryEndDate

yyyy-MM-ddTHH24:mm:ss Vade Bitiş Tarihi bilgisidir.
Id, VinovNumber, InstructionStartDate ve InstructionEndDate alanları boş ise bu alan Zorunludur.
Koşullu Zorunlu

InstructionStartDate

yyyy-MM-ddTHH24:mm:ss Talimat Başlangıç Tarihi bilgisidir.
Id, VinovNumber, ExpiryStartDate ve ExpiryEndDate alanları boş ise bu alan Zorunludur.
Koşullu Zorunlu

InstructionEndDate

yyyy-MM-ddTHH24:mm:ss Talimat Bitiş Tarihi bilgisidir.
Id, VinovNumber, ExpiryStartDate ve ExpiryEndDate alanları boş ise bu alan Zorunludur.
Koşullu Zorunlu

InstructionCreationType

Integer (1) Talimat Oluşturma Şekli bilgidir.
Alan değerleri;
Tckn = 1,
Vkn = 2,
CepTelefonu = 3,
Qr = 4
Id veya VinovNo alanlarından biri girildiyse bu alan boş olmalıdır.
Koşullu Opsiyonel

InstructionStatusCode

Integer (1) Talimat Durum Kodu bilgisidir.
Alan değerleri ;
OnayBekliyor = 1,
Onaylandi = 2,
IptalEdildi = 3
Opsiyonel


Çıktı Bilgileri

WorkPlaceInstruction

Alan Adı Format Açıklama

WorkPlaceId

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

Id

Integer(19) Id bilgisidir.

InstructionDate

yyyy-MM-ddTHH24:mm:ss Talimat Tarihi bilgisidir.

InstructionStatusCode

Integer (1) Talimat Durum Kodu bilgisidir.
Alan değerleri ;
OnayBekliyor = 1,
Onaylandi = 2,
IptalEdildi = 3

InstructionAmount

Decimal(26,2) Talimat tutar bilgisidir.

ExpiryDate

yyyy-MM-ddTHH24:mm:ss Vade Tarihi bilgisidir.

CancellationDate

yyyy-MM-ddTHH24:mm:ss İptal tarihi bilgisidir.
İptal edilmiş bir kayıt ise tarih alanı dolu gelecektir.

NumberofInstallments

Integer (3) Taksit sayısı bilgisidir.

ReceiverIdentityTaxNumber

String(11) Alıcı TCKN / VKN bilgisidir.
ReceiverPhoneNumber dolu ise bu alan boş gelecektir.

ReceiverNameSurname

String(250) Alıcı Adı Soyad bilgisidir.

ReceiverPhoneNumber

String(10) Alıcı Cep telefon numarası bilgisidir.
ReceiverIdentityTaxNumber dolu ise bu alan boş gelecektir.

DemandType

Integer(1) Talep tipi bilgisidir.
Alan değerleri:
Konut = 1,
Arac = 2,
Makine = 3,
Diğer = 4

InstructionCreationType

Integer(1) Talimat oluşturma şekli bilgisidir.
Alan değerleri:
Tckn = 1,
Vkn = 2,
CepTelefonu = 3,
Qr = 4

CancellationReasonCode

Integer(1) İptal Neden kodu bilgisidir.
Alan değerleri:
BorcluIptal = 1,
OtomatikIptal = 2,
IsyeriIptal = 3,
Diger = 4
IPTALTARIHI alanı dolu ise dolu olacaktır.

InvoiceNumber

String (50) Fatura numarası bilgisidir.

PaymentPurpose

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

DealerNumber

String(100) Bayi numarası bilgisidir.

IdentityNumber

String(12) Öğrenci TC kimlik numarası bilgisidir.


Mesaj Kodları

Mesaj Kodu Açıklama

ACBH000466

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

ACBH000476

Talimat durum kodu alanına geçersiz bir değer girildi.

ACBH000469

Vade Başlangıç Tarihi boş olamaz.

ACBH000470

Vade Başlangıç Tarihi uygun formatta girilmelidir.

ACBH000029

Vade bitiş tarihi formatı hatalıdır.

ACBH000471

Vade Bitiş Tarihi boş olamaz.

ACBH000472

Talimat Başlangıç Tarihi boş olamaz.

ACBH000473

Talimat Başlangıç Tarihi uygun formatta girilmelidir.

ACBH000474

Talimat Bitiş Tarihi boş olamaz.

ACBH000475

Talimat Bitiş Tarihi uygun formatta girilmelidir.

ACBH000478

Vade Tarihleri veya Talimat Tarihleri alanlarından birinin girilmesi zorunludur.

Örnek

İstek:

{
    "WorkPlaceId": 11001,
    "ExpiryStartDate":"2022-12-04T00:00:00+03:00",
    "ExpiryEndDate":"2022-12-04T00:00:00+03:00"
}

Cevap:

{
    "Header": {
        "StatusCode": "APIGW000000",
        "StatusDescription": "Tamamlandı",
        "StatusDescriptionEn": "Completed",
        "ObjectID": "eb3e121b-7dab-4b6c-9645-b30fa83a7e02"
    },
    "Data": {
        "WorkPlaceInstruction": [
            {
                "ExpiryDate": "2022-12-04T00:00:00",
                "InstructionCreationType": 1,
                "CancellationDate": "",
                "ReceiverNameSurname": "",
                "ReceiverIdentityTaxNumber": 11111111111,
                "PaymentPurpose": 1,
                "NumberofInstallments": 2,
                "InstructionAmount": 150,
                "CancellationReasonCode": "",
                "DemandType": "",
                "WorkPlaceId": 11001,
                "DealerNumber": "",
                "InstructionDate": "2021-12-29T12:20:21",
                "InvoiceNumber": "",
                "ReceiverPhoneNumber": "",
                "InstructionStatusCode": 1
            },
            {
                "ExpiryDate": "2022-12-04T00:00:00",
                "InstructionCreationType": 1,
                "CancellationDate": "",
                "ReceiverNameSurname": "",
                "ReceiverIdentityTaxNumber": 11111111111,
                "PaymentPurpose": 1,
                "NumberofInstallments": 2,
                "InstructionAmount": 150,
                "CancellationReasonCode": "",
                "DemandType": "",
                "WorkPlaceId": 11001,
                "DealerNumber": "",
                "InstructionDate": "2021-12-29T12:22:14",
                "InvoiceNumber": "",
                "ReceiverPhoneNumber": "",
                "InstructionStatusCode": 1
            }
			     ]
    }
}