Skip to main content

Glossary

TermDefinition
PaymentA single invoice created via the API, paid on-chain by a customer, and resolved to a terminal status.
Payment UIDThe payment's UUID (paymentUid / paymentId). Your correlation key for the callback, webhook, and verify — and, in API mode, the credential.
Hosted CheckoutThe Finomesh-hosted payment page you redirect customers to. The default mode.
API ModeEmbedded checkout — you render your own payment page and drive the flow server-to-server. IP-allowlisted.
CallbackThe browser redirect to your callbackUrl after a hosted payment resolves. Forgeable — a UX hint, not authoritative.
WebhookThe signed server-to-server POST to your webhookUrl on a terminal status. A reliable trigger — still not the source of truth.
VerifyPOST /payments/{id}/verify — the authoritative read returning the real status and amounts. Fulfil only on this.
OfferOne payable crypto asset on a payment, with its amount, fees, and total. Served in offers[].
AssetA specific crypto token on a specific network (e.g. USDT on TRON).
GatewayYour integration's container — owns its API key, enabled assets, fee settings, and webhook secret.
SettlementA payout of your balance to an external address (also called cashout).
CashoutWithdrawing your gateway balance, via the dashboard or the (off-by-default) cashout API.
Idempotency KeyA client-supplied header that makes settlement creation safe to retry without duplicating the payout.
SignatureThe HMAC that authenticates a webhook (X-Webhook-Signature) or a cashout request (X-Signature).
AllowlistThe set of server IPs permitted to make API-mode and cashout calls for a gateway.
Amount DeviationHow a slightly-off payment is judged against your tolerance → SUCCESS / ACCEPTABLE / MISMATCH.
Acceptable PaymentA payment paid within your configured tolerance (ACCEPTABLE) — safe to fulfil.
Mismatch PaymentA payment paid outside tolerance (MISMATCH) — hold for manual review.
Expired PaymentAn unpaid payment past its deadline (EXPIRED, terminal).