The terms used across the API, in plain words.
| Term | Meaning |
|---|---|
| MID | Merchant ID. It identifies which of your merchants or products a request belongs to. Required as a header on every call. |
| Customer | You: the organization that holds the TransFi account. |
| Merchant, sub-merchant | A business you onboard under your account. Each can have its own MID. |
| User | Anyone who pays or gets paid. Has a userId that starts with UX-. |
| Sender | A user who is allowed to fund orders. Needs KYC or KYB. |
| Recipient | A user who is allowed to be paid, in fiat, in crypto, or both. |
| Order | One movement of money. Has an orderId that starts with OR-, or PF- for a pre-fund. |
partnerId | Your own reference for an order, and the idempotency key. |
| Pre-fund | Money you add to your balance so that you can pay out. |
| MCA | Multi-Currency Account: your balances in many fiat and crypto currencies. |
| Settlement | Paying your collected money out to your own bank account or wallet, in batches. |
| Virtual account | A real account number (IBAN) that receives bank transfers for you or for one of your users. |
| Locked, available | Locked money has arrived but is not yet matched to an order. Available money can be used. |
| Quote | A rate and fee breakdown with a quoteId, valid for a short time. |
| Ticker | A currency code. Crypto tickers include the network, for example USDTPOLYGON. |
| Network | The blockchain a token moves on. Sending on the wrong network loses the funds. |
| Headless | You build the payment step yourself instead of using the hosted payUrl. |
payUrl | The hosted payment page you send a payer to. |
| POBO, COBO | Pay on behalf of, and collect on behalf of, your own customer. |
| KYC, KYB | Identity verification for people, and for companies. |
| Purpose code | Why the money is moving. Required on every order. |
| Scan Pay | Paying a merchant by scanning their QR code. Previously called QR payments. |
traceId | The 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.