Enums

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

Which way money moves, or which side a quoted amount is on.

ValueMeaning
depositMoney coming in — collections, on-ramp funding, pre-funds
withdrawMoney going out — payouts, off-ramp, settlement accounts
forwardThe amount you pass is what is sent; the quote tells you what is received
reverseThe amount you pass is what must be received; the quote tells you what to send

userType

Whether a user is a person or a company.

ValueMeaning
individualA person — verified by KYC
businessA company — verified by KYB

orderType

The flow an order runs, or the flow you are asking about.

ValueMeaning
depositMoney coming in — used when asking for rates or methods on the pay-in side
withdrawMoney going out — used when asking for rates or methods on the pay-out side
onrampYour user buys crypto with local currency
offrampYour user sells crypto for local currency
payinA customer pays you (collection)
payoutYou pay a person or business from your balance
fiat_prefundYou add your own fiat to your balance
crypto_prefundYou add your own crypto to your balance
swapYou convert a balance you hold into another currency
gamingA customer pays you through a custodial wallet created in their name

paymentType

The kind of payment method.

ValueMeaning
bank_transferBank rails — SEPA, SWIFT, local ACH, PIX, SPEI
cardDebit or credit card
local_walletMobile money or e-wallet — M-Pesa, GCash, OVO
cryptoOn-chain transfer
DEFAULTNo preference — return or apply every method available

accountType

The role a user holds.

ValueMeaning
senderMay fund orders
recipient_fiatMay be paid in fiat
recipient_cryptoMay be paid in crypto
recipientMay be paid (fiat or crypto)
bothHolds sender and recipient roles

accountIdentifierType

The kind of payout account a recipient is paid to.

ValueMeaning
bank_accountLocal bank account number
ibanIBAN
e_walletE-wallet identifier
mobile_walletMobile-money number
crypto_wallet_addressOn-chain address

type

Used on several fields: the kind of user, the kind of currency, the kind of payout account, or the kind of validation rule.

ValueMeaning
individualA person
organizationA business
emailEmail address
phonePhone number
cryptoToken on a blockchain
fiatGovernment-issued currency

currencyType

Whether a currency is fiat or crypto.

ValueMeaning
fiatGovernment-issued currency (EUR, PHP)
cryptoToken on a blockchain (USDT, USDC)

targetRole

The role you want an existing user to gain.

ValueMeaning
recipientAdd the right to be paid
senderAdd the right to fund orders

toPaymentType

The kind of payment method on the destination side of a fiat swap.

ValueMeaning
bank_transferBank rails
local_walletMobile money or e-wallet
cardCard
DEFAULTNo preference

locale

The language of hosted pages.

ValueMeaning
enEnglish
idIndonesian
zhChinese
ptPortuguese
esSpanish
viVietnamese
tlTagalog
bnBengali

walletOwner

Who controls a destination wallet.

ValueMeaning
exchangeThe wallet is at an exchange — also send exchangeName
selfThe recipient controls the wallet (self-custody)

currency

The currencies Scan Pay supports.

ValueMeaning
VNDVietnamese dong — VietQR
BRLBrazilian real — PIX QR

beneficiaryType

Whether an account belongs to a person or a company.

ValueMeaning
individualThe account belongs to a person
businessThe account belongs to a company

status

The state of a record such as a settlement account.

ValueMeaning
activeIn use
inactiveDisabled; cannot be used

reportFormat

The file format of a settlement report.

ValueMeaning
csvComma-separated values
xlsxExcel workbook

depositType

The kind of sandbox bank transfer to simulate.

ValueMeaning
prefundingArrives available, like a transfer from your own registered account
collectionsArrives locked, like a real customer transfer; reconcile it to release