Every field with fixed values, and what each value means.
Every field with a fixed set of values, and what each value means. The same table appears on the field itself, on every endpoint that uses it.
Order statuses and failure codes are on Orders & Statuses.
direction
directionWhich way money moves, or which side a quoted amount is on.
| Value | Meaning |
|---|---|
deposit | Money coming in — collections, on-ramp funding, pre-funds |
withdraw | Money going out — payouts, off-ramp, settlement accounts |
forward | The amount you pass is what is sent; the quote tells you what is received |
reverse | The amount you pass is what must be received; the quote tells you what to send |
userType
userTypeWhether a user is a person or a company.
| Value | Meaning |
|---|---|
individual | A person — verified by KYC |
business | A company — verified by KYB |
orderType
orderTypeThe flow an order runs, or the flow you are asking about.
| Value | Meaning |
|---|---|
deposit | Money coming in — used when asking for rates or methods on the pay-in side |
withdraw | Money going out — used when asking for rates or methods on the pay-out side |
onramp | Your user buys crypto with local currency |
offramp | Your user sells crypto for local currency |
payin | A customer pays you (collection) |
payout | You pay a person or business from your balance |
fiat_prefund | You add your own fiat to your balance |
crypto_prefund | You add your own crypto to your balance |
swap | You convert a balance you hold into another currency |
gaming | A customer pays you through a custodial wallet created in their name |
paymentType
paymentTypeThe kind of payment method.
| Value | Meaning |
|---|---|
bank_transfer | Bank rails — SEPA, SWIFT, local ACH, PIX, SPEI |
card | Debit or credit card |
local_wallet | Mobile money or e-wallet — M-Pesa, GCash, OVO |
crypto | On-chain transfer |
DEFAULT | No preference — return or apply every method available |
accountType
accountTypeThe role a user holds.
| Value | Meaning |
|---|---|
sender | May fund orders |
recipient_fiat | May be paid in fiat |
recipient_crypto | May be paid in crypto |
recipient | May be paid (fiat or crypto) |
both | Holds sender and recipient roles |
accountIdentifierType
accountIdentifierTypeThe kind of payout account a recipient is paid to.
| Value | Meaning |
|---|---|
bank_account | Local bank account number |
iban | IBAN |
e_wallet | E-wallet identifier |
mobile_wallet | Mobile-money number |
crypto_wallet_address | On-chain address |
type
typeUsed on several fields: the kind of user, the kind of currency, the kind of payout account, or the kind of validation rule.
| Value | Meaning |
|---|---|
individual | A person |
organization | A business |
email | Email address |
phone | Phone number |
crypto | Token on a blockchain |
fiat | Government-issued currency |
currencyType
currencyTypeWhether a currency is fiat or crypto.
| Value | Meaning |
|---|---|
fiat | Government-issued currency (EUR, PHP) |
crypto | Token on a blockchain (USDT, USDC) |
targetRole
targetRoleThe role you want an existing user to gain.
| Value | Meaning |
|---|---|
recipient | Add the right to be paid |
sender | Add the right to fund orders |
toPaymentType
toPaymentTypeThe kind of payment method on the destination side of a fiat swap.
| Value | Meaning |
|---|---|
bank_transfer | Bank rails |
local_wallet | Mobile money or e-wallet |
card | Card |
DEFAULT | No preference |
locale
localeThe language of hosted pages.
| Value | Meaning |
|---|---|
en | English |
id | Indonesian |
zh | Chinese |
pt | Portuguese |
es | Spanish |
vi | Vietnamese |
tl | Tagalog |
bn | Bengali |
walletOwner
walletOwnerWho controls a destination wallet.
| Value | Meaning |
|---|---|
exchange | The wallet is at an exchange — also send exchangeName |
self | The recipient controls the wallet (self-custody) |
currency
currencyThe currencies Scan Pay supports.
| Value | Meaning |
|---|---|
VND | Vietnamese dong — VietQR |
BRL | Brazilian real — PIX QR |
beneficiaryType
beneficiaryTypeWhether an account belongs to a person or a company.
| Value | Meaning |
|---|---|
individual | The account belongs to a person |
business | The account belongs to a company |
status
statusThe state of a record such as a settlement account.
| Value | Meaning |
|---|---|
active | In use |
inactive | Disabled; cannot be used |
reportFormat
reportFormatThe file format of a settlement report.
| Value | Meaning |
|---|---|
csv | Comma-separated values |
xlsx | Excel workbook |
depositType
depositTypeThe kind of sandbox bank transfer to simulate.
| Value | Meaning |
|---|---|
prefunding | Arrives available, like a transfer from your own registered account |
collections | Arrives locked, like a real customer transfer; reconcile it to release |