API referansı
Apex Settlement Müşteri API'sinin tüm uç noktaları, OpenAPI 3.1 belgesinden üretilir.
Referans, API'nin üzerine kurulduğu OpenAPI belgesinin kendisinden üretilir; sunucunun kabul ettiklerinden hiçbir zaman ayrışmaz. Her uç nokta sayfası parametreleri, istek gövdesini ve yanıtları; cURL, JavaScript, Python ve Go kod örneklerini ve gerçek istek gönderen bir deneme alanını gösterir. Uç nokta açıklamaları İngilizcedir.
Temel adres
Tüm yollar /v1 ile başlar. Anahtarınıza uyan sunucuyu seçin:
http://localhost:3480Local developmentHer ortamın ne için olduğunu Ortamlar sayfasında bulabilirsiniz.
Kimlik doğrulama
API anahtarınızı her istekte bearer token olarak gönderin:
Authorization: Bearer ak_test_…Sandbox anahtarları ak_test_, canlı anahtarlar ak_live_ ile başlar. Ayrıntılar için Kimlik doğrulama.
Deneme alanı yalnızca sandbox anahtarları içindir
Dene alanı istekleri doğrudan tarayıcınızdan gönderir ve anahtarı bu sekmenin oturum belleğinde tutar. Oraya yalnızca ak_test_ anahtarları yapıştırın, asla canlı anahtar değil. İstek API'ye ulaşmadan başarısız olursa sandbox bu siteden gelen isteklere (CORS) izin vermiyor olabilir; bunun yerine cURL örneğini kullanın.
İndirmeler
- OpenAPI 3.1 belgesi: kendi araçlarınıza aktarın ya da istemci üretin.
- Postman koleksiyonu: içe aktardıktan sonra
baseUrlveapiKeydeğişkenlerini ayarlayın.
Hatalar
Her hata, kodunuzun dallanabileceği sabit bir code içeren aynı zarfla döner. Zarf ve tüm kodların listesi için Hatalar.
Uç noktalar
Customer
The Customer the API key belongs to: its name, its standing and the Providers that approved it.
Onboarding
Passing due diligence: the Compliance Profile, its documents and the terms, then submission for review. These are the only operations open while the Customer is being onboarded.
Balances
What the Customer holds, per asset and per Provider, available to spend and held for Payouts.
Deposits
Where the Customer sends funds to credit its balance. A credited Deposit is announced by the `deposit.received` webhook.
Beneficiaries
The parties the Customer pays: an outside party, its own account elsewhere, or another Customer added by its Receiving Code.
Quotes
What sending an amount to a Beneficiary would cost and deliver, one Quote per eligible Route, each valid for a short time.
Payouts
Accepting a Quote into a Payout, following it to completion, and cancelling it while nothing is reserved for it.
Receiving
Being paid by other Customers: the Receiving Code the Customer hands out and the account those Payouts are paid into.
Incoming payouts
Payouts other Customers sent this Customer, as the receiver sees them.
Webhooks
Endpoints that receive signed notifications of the Customer's Payouts, Deposits and Beneficiaries, and their deliveries.
End customers
The Platform API: a Platform opens and manages its End Customers, and acts for one on the other operations with the `Apex-End-Customer` header.