İçeriğe atlayın

API

Bu sayfada

Genel bakış

Paymos'u arka ucunuza imzalı, ortam izoleli webhook uç noktaları ve eksiksiz bir teslimat iş akışıyla bağlayın.

Paymos, bir fatura, çekim ya da ödeme kanalı yatırması durum değiştirdiğinde HTTPS POST gönderir. Webhook'lar arka ucunuz için yetkili eşzamansız sinyaldir: API yanıtları bir işlemi başlatır; webhook olayları blockchain işlemesi sonrasında ne olduğunu bildirir.

Entegrasyon akışı

  1. Panel → Geliştirici → Webhook'lar bölümünde bir webhook uç noktası oluşturun.
  2. Bir veya daha fazla olay kategorisi seçin: Invoice, Withdrawal, Payment channel.
  3. İsteğe bağlı olarak fatura ve ödeme kanalı olaylarını seçili projelerle sınırlayın; ikisi tek bir filtreyi paylaşır. Çekim olayları satıcı genelindedir ve bu filtreyi yok sayar.
  4. Gösterilen whsec_… sırrını sunucunuzda saklayın.
  5. Her teslimatı değiştirilmemiş ham istek gövdesine karşı doğrulayın.
  6. event_id değerini kalıcı kaydedin, 2xx ile onaylayın ve olayı eşzamansız işleyin.

Üretim ve Sandbox'ın ayrı uç noktaları, sırları ve olayları vardır. Bir sandbox olayı asla üretim uç noktasına teslim edilmez.

Uç nokta kuralları

  • URL HTTPS kullanmalıdır.
  • Satıcı ve ortam başına en fazla 10 uç nokta yapılandırılabilir.
  • Aynı etkin URL bir ortamda iki kez kaydedilemez.
  • Bir uç nokta en az bir kategoriye abone olmalıdır.
  • Proje filtresi yoksa tüm projeler dahildir.
  • Bir uç noktayı askıya almak veya silmek, ona yeni teslimatları durdurur.

Teslimat başlıkları

Başlık Sözleşme
Content-Type application/json; charset=utf-8
X-Webhook-Id Kararlı evt_… kimliği; yeniden denemeler ve manuel tekrar gönderimlerde değişmez
X-Webhook-Timestamp Bu teslimat denemesinin Unix saniyesi
X-Webhook-Signature t={timestamp},v1={hmac_hex}; rotasyon sırasında iki v1 değeri içerebilir

Teslimat at-least-once'tır ve sıralama garanti edilmez. X-Webhook-Id ile tekilleştirin, ardından olay saymak veya varış sırası varsaymak yerine data içindeki kaynak durumunu uygulayın.

Webhook dokümantasyonu

Kanal Yatırması Simüle Et Webhook olayları