Banka hareketini cariye veya faturaya işle
status=0 olan banka hareketini contact veya invoice türünde onaylar ve ödeme kaydı oluşturur.
PATCH
Mali işlem sonucunu ve varsa
operationId değerini saklayın. Zaman aşımında veya review_required durumunda otomatik
tekrar yapmayın. Tamamlanmış tekrar cevabı ilk cevabın bütün gövdesini yeniden sunmaz. İşlem
takibiNe yapar?
status=0 olan banka hareketini contact veya invoice türünde onaylar ve ödeme kaydı oluşturur. contact türünde id, mevcut cari kimliği veya yeni cari adı olabilir. invoice türünde id ve contactsId zorunludur; cari, fatura, para birimi ve ödeme yönü banka hareketiyle eşleşmelidir. Para birimi boşsa TRY kabul edilir; uyuşmazlık 400 döndürür. IBAN ilgili cariye kaydedilir. Fatura açık, daha önce ödeme almamış ve hareketin tam tutarıyla kapanabilir olmalıdır. Kısmi, önceden ödenmiş veya kapalı fatura 422 döndürür. Döviz hareketinde kaydedilmiş pozitif kur gerekir; TRY dışında kur=1 veya fatura kuruyla uyuşmazlık 422 döndürür. Kur farkı hesaplama ve kısmi kapama desteklenmez. İşlem makbuzunu saklayın; replayed=true ilk cevabın bütün içeriğini tekrarlamaz. Aynı firmada çakışan banka onayı, fatura veya pazaryeri aktarımı 409 döndürebilir. Sonuç belirsizse yeniden onaylamadan işlem durumunu ve oluşan kayıtları inceleyin; okuma istekleri kullanılabilir.Ön koşullar ve izin
Etkin API anahtarı vemuhasip:bank:write izni gerekir.
İlişkili kayıtlar aynı firmaya ait olmalıdır. Erişim ayarları için kimlik ve izinler rehberini inceleyin.
İstek ve cevap şemalarını indirin.
İstek örnekleri
Örnekler temsilîdir. Kimlikleri, belge tarihlerini ve iş verisini kendi yetkili kayıtlarınızla değiştirin. Node.js örnekleri Node.js 20 veya üzeri içindir; PHP örnekleri cURL uzantısını kullanır. Hiçbiri otomatik tekrar yapmaz.- cariyeOdeme
- faturayaMahsup
Cevabı değerlendirin
Önce HTTP durumunu, ardından bu kaynağınstatus ve sonuç alanlarını değerlendirin. Bütün uçlar aynı sonuç zarfını veya oluşturma için 201 kodunu kullanmaz.
Temsilî başarılı cevap; gerçek hizmet çağrısından alınmamıştır:
replayed:true varsa cevap güvenli makbuz ve sonuç kimlikleriyle sınırlı olabilir. İlk HTML/PDF veya mali gövdeyi tekrar beklemeyin. reviewRequired:true veya retryable:false yeni bir mali çağrı izni değildir.
Hata durumunda
Ağ kesintisi, zaman aşımı veya JSON olmayan cevap mali etkinin oluşmadığını kanıtlamaz. Ham istek/cevapları genel loglara yazmayın. Hata yönetimi
Sonraki adım
İşlem makbuzunu saklayın; durum adresinden kontrol edin ve sonuç kimliklerini ilgili belge/tahsilat/siparişle eşleştirin. reviewRequired=true ise yeniden göndermeden manuel inceleyin. Kaynak akışı · İşlem takibi · Kapsam ve sınırlamalarYetkilendirmeler
Kullanıcı adı apiUserId, parola secretKey. Aktif ve süresi geçmemiş API kullanıcısı ve uygun firma gerekir.
Yol Parametreleri
İşlem yapılacak kayıt kimliği. 24 haneli kayıt kimliği; firma API kimliğinden belirlenir.
Pattern:
^[a-fA-F0-9]{24}$Gövde
application/json