Giriş
Apex Settlement API ile yurt dışındaki kişi ve şirketlere kendi sistemlerinizden ödeme yapın.
API ne yapar
Apex Settlement API, sistemlerinizin bizdeki bakiyenizden sınır ötesi ödeme göndermesini sağlar. Ödeme yaptığınız kişi ya da şirketi alıcı olarak kaydeder, teklif ister ve tekliflerden birini kabul edersiniz. Her teklif, lisanslı Provider'larımız üzerinden tek bir rota için her şey dahil bir fiyattır: Provider'ların kuru olduğu gibi yansıtılır, her ücret ayrı bir satırda görünür. Kabul ettiğiniz teklif bir ödemeye dönüşür. Ödemeyi adım adım (Leg) yürütür, her değişikliği imzalı webhook'larla sunucunuza bildiririz. Bir Platform, aynı çağrılarla tüm bunları kendi End Customer'ları için yapar.
API, HTTPS üzerinden JSON ile çalışır. Tüm yollar /v1 ile başlar. Sistemleriniz, müşteri panelinde hesabınızın bir yöneticisinin oluşturduğu API anahtarıyla kimlik doğrular.
Temel nesneler
| Nesne | Nedir | Başlıca uç noktalar |
|---|---|---|
| Teklif (Quote) | Bir tutarı tek bir alıcıya tek bir rota üzerinden göndermenin kısa süre geçerli, her şey dahil fiyatı. Uygun her rota için bir teklif alır, birini kabul edersiniz. | POST /v1/quotes |
| Ödeme (Payout) | Kabul ettiğiniz teklif: bakiyenizden çıkıp alıcıya ulaşan para. processing ve completed gibi durumlardan geçer. | POST /v1/payouts, GET /v1/payouts/{id} |
| Alıcı (Beneficiary) | Ödeme yaptığınız kişi ya da şirket ve hedefin istediği hesap bilgileri. Her alıcı ödenebilmeden önce tarafımızca doğrulanır. | POST /v1/beneficiaries, GET /v1/beneficiaries |
| Bakiye (Balance) | Bir varlıkta tuttuğunuz tutar; onu tutan Provider'a göre ayrılmış olarak. Bir ödeme tek bir Provider'daki kısımdan gönderilir. | GET /v1/balances |
| Webhook uç noktası | Ödemeleriniz, para yatırmalarınız ve alıcılarınızla ilgili imzalı bildirimleri alan HTTPS adresiniz. | POST /v1/webhooks |
| End Customer | Bir Platformun müşterisi. Kendi bakiyesi ve kendi doğrulama süreci vardır; Platform onun adına işlem yapar. | POST /v1/end-customers |
Bir ödeme nasıl ilerler
- Sunucunuz, bir tutar ve doğrulanmış bir alıcı için teklif ister.
- Tekliflerden birini
expires_atzamanından önce bir ödeme oluşturarak kabul edersiniz.Idempotency-Keybaşlığı bu çağrıyı güvenle yeniden denenebilir kılar. - Tutar bakiyenizden alınır ve rotanın adımları Provider'larda yürütülür.
- Her durum değişikliği webhook uç noktanıza gönderilir. Ödemeyi istediğiniz zaman API'den de okuyabilirsiniz.