Glossary
The words this documentation uses without stopping to define them.
In plain EnglishThe words this documentation uses without stopping to define them. If you are
reading a guide and a term is doing more work than you expected, it is
probably here.
The money
Balance β the funded USD you hold with us. Payouts debit it. You top it up
by wire; in the sandbox you set it yourself. Everything you send comes out of
this, which is why an underfunded balance fails at pricing rather than at
delivery.
Reversal β a row in your balance history where money came back: a
cancelled payout, or one a receiving bank returned. If your balance is not the
number you expected, the history is where the answer is.
Corridor β a currency you can pay into, plus the fields that currency
requires. USD β MXN is a corridor. Which corridors you have depends on how
your organization is routed, and routing can change, so you ask us for the list
rather than hardcoding one.
Rate β how many units of the destination currency one unit of the source
currency buys. On a quote the fee comes out of the amount you send; on a
completed payout the fee is already inside both numbers. Two different
identities, which is why the same word behaves differently on the two pages.
Indicative quote β a price with no commitment and no beneficiary attached.
What you show someone while they are still typing an amount.
Binding quote β a price locked against a real beneficiary. Money can move
against it, and it expires.
The people
Beneficiary β the person or company receiving the money, together with the
bank details needed to reach them. You register them once and pay them many
times.
End user β your customer: the person on whose behalf you are sending. They
never sign up with Avvio. Attributing a beneficiary to an end user is what stops
one of your users seeing another's saved bank accounts.
Sender of record β you. The money leaves your balance, and the recipient is
your counterparty, not ours.
External id β your own identifier for a beneficiary. Sending the same one
twice returns the beneficiary you already created instead of registering a
second bank account. One external id means one account, permanently.
The bank details
CLABE β Mexico's 18-digit standardised bank account number. It carries a
check digit, so a typo is caught before anything is sent.
IBAN β the international account number format used across Europe and
beyond.
IFSC β the code identifying an Indian bank branch. India needs it and the
account number, which is why one corridor is one field and another is two.
SWIFT / BIC β the code identifying a bank internationally, used on the
correspondent-banking rails rather than local ones.
The mechanics
Idempotency key β a value you generate and attach to anything that moves
money. Send the same one again and you get the original result rather than a
second payment. This is what makes retrying a timed-out request safe, and it is
independent of how you authenticate.
API key β the credential itself, avvio_live_β¦ or avvio_test_β¦. Not an
identifier: whoever holds it can spend. Shown once, stored by us only as a hash.
Webhook β a message we push when a payout changes state. The nudge to go and
look, never the source of truth.
Event log β a numbered, replayable list of everything that happened to your
organization. What you reconcile against when a webhook was missed or your
system was down.
The environments
Sandbox β the same API, the same validation, the same errors, no payment
network. Decided by your key: a test key cannot move real money.
Trigger β a deliberate outcome in the sandbox, chosen by the last four
digits of a recipient's account number. 0003 completes and then fails, which
is the case most ledgers get wrong.
Going live β swapping a test credential for a live one. The base URL, the
paths and the payloads do not change.
Updated about 1 month ago