Cashout / Settlements
The cashout API lets your servers withdraw your available balance to a destination address programmatically — the API equivalent of the dashboard's Cashout page. Because it moves money out, it is treated as security-sensitive and kept separate from payment acceptance.
New to the concept? Settlement / Cashout explains balances, maturation, and the settlement lifecycle.
Security posture
The cashout API is off by default and hardened on two independent axes — a request must satisfy both:
- Server IP allowlist — every call must originate from an IP you have whitelisted.
- HMAC request signing — every call must carry a valid
X-Timestamp+X-Signature, keyed with a signing secret shown to you only once.
An unsigned or off-allowlist request is rejected before it can move any funds.
The integration path
- Enable the cashout API — Finomesh switches it on, you generate a signing secret and allowlist your server IPs.
- Sign every request — the HMAC scheme used by all three endpoints.
- Call the endpoints:
- Get balances — what you can withdraw now.
- Estimate cashout fee — preview the network fee + net before you commit (optional).
- Create a settlement — request a payout.
- Get settlement status — track it to a terminal state.
- Handle cashout errors.
The full endpoint contracts (field tables) live in the Cashout Endpoints reference.