Ana içeriğe atla
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 takibi

Ne yapar?

Yalnız logout,getUserData,query,html,download,cancel,verifyPhoneNumber,sign,send türleri kabul edilir. query için giden/itiraz ve sıralı iki ISO tarih; html/download için UUID ve signed boolean zorunludur. send ve verifyPhoneNumber Idempotency-Key ister. İptal belge tarihindeki hesaba ait listede doğrulanır; sağlayıcı iptali kesinleşmeden yerel bağ kaldırılmaz. sign yalnız GİB sonuc=1 ile başarı sayılır. send kesin ETTN sunamazsa 502 review_required döner; rastgele veya son listedeki belge UUID değeri kullanılmaz. İşlem takibi: yanıttaki operation makbuzunu saklayın; replayed=true cevabı ilk yanıtın bütün içeriğini tekrar etmez. İmzada aynı ETTN+OID farklı SMS koduyla tekrar kullanılırsa 409; kesin yanlış koddan sonra yeni SMS challenge/oid alınmalıdır.

Ön koşullar ve izin

func=getUserData|query|html|download için muhasip:earsiv:read; diğer belgelenmiş türler için muhasip:earsiv:write gerekir. send ve verifyPhoneNumber için Idempotency-Key zorunludur. İlişkili kayıtlar aynı firmaya ait olmalıdır. Erişim ayarları için kimlik ve izinler rehberini inceleyin. İşlem anahtarı: func=send veya verifyPhoneNumber için zorunlu. Aynı işlem için aynı anahtarı kullanın; örnekler MUHASIP_IDEMPOTENCY_KEY ortam değişkenini kullanır. İ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.

Cevabı değerlendirin

Önce HTTP durumunu, ardından bu kaynağın status 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ırlamalar

Yetkilendirmeler

Authorization
string
header
gerekli

Kullanıcı adı apiUserId, parola secretKey. Aktif ve süresi geçmemiş API kullanıcısı ve uygun firma gerekir.

Başlıklar

Idempotency-Key
string

func=send veya verifyPhoneNumber için zorunlu.

Required string length: 1 - 128
Pattern: ^[!-~]+$

Gövde

application/json

Yalnız listelenen func değerleri desteklenir. Bilinmeyen func/type yanıt üretmeyebilir.

func
enum<string>
gerekli
Mevcut seçenekler:
logout

Yanıt

İşlem sonucu.

İlk çağrı kaynağa özgü yanıtı ve işlem makbuzunu; tamamlanmış tekrar yalnız güvenli makbuzu ve uygun sonuç kimliklerini döndürür.

status
boolean
gerekli
message
string
gerekli
operation
object
operations
object[]
replayed
boolean