Account & Channels API
Balance, enforced limits, channels and your effective fees.
Authentication
Every request is authenticated with your secret key in the apiToken header. There is one base URL and one key: your account behaves as a sandbox until go-live is approved, on the same URL. Keep the key server-side only, and note that rotating it expires the previous one immediately.
Required Headers
apiToken
sp_sk_prod_XXXXXXXXXXXX
Content-Type
application/json
Overview
Read your available balance, the caps actually being enforced today, and the channels enabled on your project. GET /api/v1/project/fees is the authoritative source for what you are charged — rates are negotiable, so never hard-code them.
Account Balance
Your confirmed balance and the amount still awaiting confirmation. A successful collection credits your wallet net of the fee.
Use zonmpay.com specifically (without www the request is redirected and some HTTP clients drop the POST body — which causes a server error).
curl https://zonmpay.com/api/v1/payment/balance \
-H "apiToken: SPP_live_YOUR_API_KEY"Limits & Balance
Returns the limit actually being enforced for each direction along with today's usage and your available balance — the fastest way to tell whether you are hitting a cap or a genuine failure.
Use zonmpay.com specifically (without www the request is redirected and some HTTP clients drop the POST body — which causes a server error).
curl https://zonmpay.com/api/v1/payment/limits \
-H "apiToken: SPP_live_YOUR_API_KEY"Available Channels
Lists the collection and disbursement channels enabled on your project. Read it at startup rather than hard-coding a channel list, so a newly enabled rail works without a deploy.
Use zonmpay.com specifically (without www the request is redirected and some HTTP clients drop the POST body — which causes a server error).
curl https://zonmpay.com/api/v2/payment/channels \
-H "apiToken: SPP_live_YOUR_API_KEY"Note: This is also the quickest harmless call to confirm an apiToken works.
Your Effective Fees
The authoritative source for what you are actually charged. Rates are negotiable, so read them here instead of assuming the published list.
Use zonmpay.com specifically (without www the request is redirected and some HTTP clients drop the POST body — which causes a server error).
curl https://zonmpay.com/api/v1/project/fees \
-H "apiToken: SPP_live_YOUR_API_KEY"