associationId when you issue
a token; the gateway resolves it server-side from your bearer token on every
request afterward — you never send it yourself.
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.
Bespoke connector: A connector with flow: BESPOKE. The customer pays the
provider first, against an on-ramp reference, instead of you quoting and
submitting the payment. See Provider on-ramps.
Connector: A payment provider integration for a specific corridor,
exposed via GET /v1/connectors. Its flow is
STANDARD (quoted and submitted) or BESPOKE (provider-initiated).
Corridor: A combination of country, payment method, and direction
(on-ramp or off-ramp) that a connector serves.
Quote: A priced off-ramp or on-ramp offer for a connector and amount, with
a rate, fees, and an expiry. Created with POST /v1/quotes
(add ?type=onramp for an on-ramp).
P2P: A same-asset transfer between your own wallets or to a beneficiary’s
crypto destination, sent with
POST /v1/payments/p2p/own or
POST /v1/payments/p2p/beneficiary.
Off-ramp: A cash-out from a wallet to a real-world payment destination,
executed against a quote with
POST /v1/payments/offramp.
On-ramp: Money paid in to one of your wallets. Either a collection from a
registered counterparty’s mobile-money payment destination, executed against an
on-ramp quote with POST /v1/payments/onramp, or
a provider on-ramp, where the customer pays a provider against an on-ramp
reference.
On-ramp reference: What a customer pays against on a bespoke connector, for
example an EasyPay number, bound to one of your wallets. Registered with
POST /v1/onramp/references.
Payment: A P2P transfer, swap, off-ramp, or on-ramp. Payments you submit are
asynchronous; the response returns a transactionRecordId with
202 Accepted. Provider on-ramp payments are not submitted by you and are
reported only through webhooks.
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.