Ana içeriğe atla
POST

Ne yapar?

Ödenmiş kaydın remainingMinor tutarının tamamını iptal/iade için gönderir. Kısmi tutar 422 BANKPOS_FULL_RETURN_REQUIRED üretir. Sağlayıcı sonucu voided veya refunded olarak doğrulanır; HTTP 200/operation.state=succeeded yalnız isteğin işlendiğini gösterir. Belirsiz sonuçta mevcut ödeme sorgulanır; yeni anahtarla tekrar mali işlem başlatılmaz. İptal/iade uygunluğu ve gün sonu koşulları sağlayıcıya bağlıdır.

Ön koşullar ve izin

Gereken izin: muhasip:epos:write. Açık izin her durumda zorunludur; genel erişim veya yönetici yetkisi bunun yerine geçmez. write tek başına read sağlamaz. Firma kimlik bilgilerinden belirlenir; ilişkili kayıtlar aynı firmaya ait olmalıdır. Firma paketi ücretli ve süresi aktif olmalıdır. Kimlik ve izinler · E-Pos entegrasyonu

İstek örnekleri

Örnekler temsilîdir. Kimlikleri, sürümleri ve işyeri bilgilerini kendi kayıtlarınızla değiştirin. Oranlar yüzde, amountMinor değerleri kuruştur. Gereken işlem anahtarını çağrıdan önce kalıcı saklayın; otomatik tekrar yapmayın. Gerçek işyeri anahtarını güvenli sunucu ortamından sağlayın. Node.js örneği Node.js 20 veya üzeri, PHP örneği cURL uzantısı gerektirir.

Cevabı değerlendirin

Aşağıdaki cevap temsilîdir; varsa url alanı örnekte yer tutucudur. Uygulamada dönen adresi doğrudan kullanın ve günlüklemeyin. operation.state=succeeded, ödeme veya iadenin mali olarak tamamlandığı anlamına gelmez. Ödeme kaydının status, verification ve iade geçmişini okuyun. Tamamlanmış tekrar cevabı ilk gövde yerine güvenli kimlikler döndürebilir.

Hata durumunda

Hata yönetimi · İşlem takibi

Sonraki adım

E-Pos entegrasyon akışını izleyin. Hesap değişikliğinde dönen revision değerini saklayın; ödemede bağlantı oluşturmayı, müşterinin 3D işlemini ve doğrulanmış mali sonucu ayrı değerlendirin.

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
gerekli

İş niyetine ait kalıcı anahtar. Farklı işlerde yeniden kullanmayın. Aynı anahtar ve farklı içerik 409 döndürür.

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

Yol Parametreleri

paymentId
string
gerekli

Aynı firmaya ait 24 haneli kayıt kimliği.

Pattern: ^[a-fA-F0-9]{24}$

Gövde

application/json
amountMinor
integer
gerekli

Güncel remainingMinor değerinin tamamına eşit olmalıdır; kısmi iade desteklenmez.

Gerekli aralık: 1 <= x <= 9007199254740991

Yanıt

İşlem cevabı; örnek temsilîdir.

status
enum<boolean>
gerekli
Mevcut seçenekler:
true
result
object
gerekli
operation
object
gerekli