Glossary

The terms used across the API, in plain words.

TermMeaning
MIDMerchant ID. It identifies which of your merchants or products a request belongs to. Required as a header on every call.
CustomerYou: the organization that holds the TransFi account.
Merchant, sub-merchantA business you onboard under your account. Each can have its own MID.
UserAnyone who pays or gets paid. Has a userId that starts with UX-.
SenderA user who is allowed to fund orders. Needs KYC or KYB.
RecipientA user who is allowed to be paid, in fiat, in crypto, or both.
OrderOne movement of money. Has an orderId that starts with OR-, or PF- for a pre-fund.
partnerIdYour own reference for an order, and the idempotency key.
Pre-fundMoney you add to your balance so that you can pay out.
MCAMulti-Currency Account: your balances in many fiat and crypto currencies.
SettlementPaying your collected money out to your own bank account or wallet, in batches.
Virtual accountA real account number (IBAN) that receives bank transfers for you or for one of your users.
Locked, availableLocked money has arrived but is not yet matched to an order. Available money can be used.
QuoteA rate and fee breakdown with a quoteId, valid for a short time.
TickerA currency code. Crypto tickers include the network, for example USDTPOLYGON.
NetworkThe blockchain a token moves on. Sending on the wrong network loses the funds.
HeadlessYou build the payment step yourself instead of using the hosted payUrl.
payUrlThe hosted payment page you send a payer to.
POBO, COBOPay on behalf of, and collect on behalf of, your own customer.
KYC, KYBIdentity verification for people, and for companies.
Purpose codeWhy the money is moving. Required on every order.
Scan PayPaying a merchant by scanning their QR code. Previously called QR payments.
traceIdThe request ID on every response. Give it to support.

Field values with fixed options, such as orderType or direction, are explained on the Enums page.