Skip to main content
Association: A Zeam business tenant. Every application and all data are scoped to one association. You receive its id as associationId when you issue a token and send it as the x-association-id header on every protected request. Application: A registered integration bound to one association. Authenticates with client credentials, not a human login. Client ID / client secret: The credentials exchanged at POST /v1/auth/token to obtain an access token. Application secret: The secret sent on every protected request as the x-zeam-auth header. Issued at registration as the apiKey. Access token: A short-lived bearer token used in the Authorization header. See Access tokens. Wallet: An account that holds balances and has a Stellar public key (G…). See the API reference. Beneficiary: A saved recipient (individual or business) under an association. Connector: A payment provider integration for a specific corridor, exposed via GET /v1/connectors. Corridor: A combination of country, payment method, and direction (on-ramp or off-ramp) that a connector serves. Quote: A priced off-ramp offer for a connector and amount, with a rate, fees, and an expiry. Created with POST /v1/quotes. P2P: A same-asset, wallet-to-wallet transfer, sent with POST /v1/payments/p2p. Off-ramp: A cash-out from a wallet to a real-world payment destination, executed against a quote with POST /v1/payments/offramp. Payment: A P2P transfer, swap, or off-ramp. Submitted asynchronously; the response returns a transactionRecordId with 202 Accepted. Transaction: The record created by a payment submission, tracked to its outcome via GET /v1/transactions/{transactionId}. Operation: A single movement within a payment. The gateway submits one operation per payment request. Webhook: A registration that delivers payment lifecycle events to your endpoint. Managed in the business portal or via the API. See Webhooks. Problem response: The RFC 7807 error format returned as application/problem+json. Request ID: The X-Request-Id on every response (mirrored as requestId in problem bodies), used to trace a request in support.