Deposit address
A deposit address is an on-chain address you create to receive stablecoins on a supported chain (e.g.BASE). Each address has a stable id — store it as your reference. Yara manages the underlying keys; you never handle private keys.
Share the address with whoever is paying you, or display it in your app.
Deposit
A deposit is an incoming stablecoin transfer to one of your addresses. Yara watches the chain, waits for confirmations, and records the deposit. OnceCONFIRMED, the USD value is credited to your merchant balance and a deposit.confirmed webhook fires.
Merchant USD balance
Confirmed deposits roll up into a single merchant USD balance — your spendable ledger balance. It has three parts:Whitelisted recipient
A recipient is a payout destination you approve in the dashboard before sending funds — a bank account or a crypto address. You reference it byrecipient_id when quoting a transfer. Funds can only ever leave to whitelisted recipients. See Whitelist an address.
Quote
A quote prices a payout to a recipient. You send anamount, a currency (e.g. NGN), and a recipient_id; you get back the gross amount, fee, net amount, the USD that will be debited, the destination rail, and an expires_at. Quotes are short-lived — initiate the transfer before it expires.
Transfer
A transfer is the payout itself. You create it from a validquote_id; Yara reserves the funds and processes it asynchronously. Track its status (e.g. RESERVED → completed) via webhooks or by fetching the transfer.
How they fit together
1
Create an address
Provision a deposit address on a supported chain.
2
Receive a deposit
Stablecoins arrive, confirm, and credit your merchant USD balance.
3
Whitelist a recipient
Approve the payout destination in the dashboard.
4
Quote, then transfer
Quote the payout, then initiate the transfer from the quote.
Next: create an address
Put these concepts to work.