Originator country code, ISO 2 digit, lower case. For more information please refer to the Countries and Regions section in the appendix.
region
STRING
YES *2
Originator region
city
STRING
YES *1
Originator’s city/village/town.
kanjiName
STRING
YES *1
kanaName
STRING
YES *1
latinName
STRING
YES *1
For more information please refer to the Name restrictions section in the appendix.
vaspName
STRING
YES
isAttested
BOOLEAN
YES
Required when depositOriginator is 1.
Required when country is cn(China) or ua(Ukraine).
If country is cn(China), region must be notNortheasternProvinces (Jilin, Liaoning
and Heilongjiang) or other.
If country is ua(Ukraine), region should not be crimea, donetsk or
luhansk，should be other.
Kazakhstan
Name
Type
Mandatory
Description
originatorName
STRING
YES
Name of originator.
country
STRING
YES
Originator country code, ISO 2 digit, lower case. For more information please refer to the Countries and Regions section in the appendix.
city
STRING
YES
Originator’s city/village/town.
txnPurpose
STRING
YES
Value: service, goods, p2p, charity, others
txnPurposeOthers
STRING
YES *1
Required when txnPurpose is others.
Bahrain
Name
Type
Mandatory
Description
depositOriginator
INTEGER
YES
1 = Myself, 2 = Not myself
orgType
INTEGER
YES *1
0 = Individual, 1 = Corporate/Entity
orgFirstName
STRING
YES *1
Originator's First Name, for more information please refer to the Name restrictions section in the appendix.
orgLastName
STRING
YES *1
Originator's Last Name, for more information please refer to the Name restrictions section in the appendix.
country
STRING
YES *1
Originator's residence country code, ISO 2 digit, lower case. For more information please refer to the Countries and Regions section in the appendix.
city
STRING
YES *1
receiveFrom
INTEGER
YES
1 = Private Wallet, 2 = Another VASP
vasp
STRING
YES *2
Vasp identifier of the originator.
vaspName
STRING
YES *3
Required when depositOriginator is 2.
Required when receiveFrom is 2.
Required when vasp is others.
The Vasp List API provides the VASP and identifier information. If the VASP cannot be found,
please input others within vasp list and the name of the exchange within vaspName field.
United Arab Emirates
Name
Type
Mandatory
Description
depositOriginator
INTEGER
YES
1 = Myself, 2 = Not myself
orgType
INTEGER
YES *1
0 = Individual, 1 = Corporate/Entity
orgName
STRING
YES *1
For more information please refer to the Name restrictions section in the appendix.
country
STRING
YES *1
Originator's nationality code, ISO 2 digit, lower case. For more information please refer to the Countries and Regions section in the appendix.
city
STRING
YES *1
receiveFrom
INTEGER
YES
1 = Private Wallet, 2 = Another VASP
vasp
STRING
YES *2
Vasp identifier of the beneficiary
vaspName
STRING
YES *3
Required when depositOriginator is 2.
Required when receiveFrom is 2.
Required when vasp is others.
The Vasp List API provides the VASP and identifier information. If the VASP cannot be found,
please input others within vasp list and the name of the exchange within vaspName field.
India
Name
Type
Mandatory
Description
depositOriginator
INTEGER
YES
1 = Myself, 2 = Not myself
orgType
INTEGER
YES *1
0 = Individual, 1 = Corporate/Entity
orgName
STRING
YES *1
Originator's Name, for more information please refer to the Name restrictions section in the appendix.
pan
STRING
YES *1
Permanent Account Number (PAN) or National ID Number
country
STRING
YES *1
Originator's nationality code, ISO 2 digit, lower case. For more information please refer to the Countries and Regions section in the appendix.
state
STRING
YES *1
Originator's State
city
STRING
YES *1
Originator’s City/Village/Town
pinCode
STRING
YES *1
address
STRING
YES *1
receiveFrom
INTEGER
YES
1 = Private Wallet, 2 = Another VASP
vasp
STRING
YES *2
Vasp identifier of the beneficiary
vaspName
STRING
YES *3
Required when depositOriginator is 2.
Required when receiveFrom is 2.
Required when vasp is others.
The Vasp List API provides the VASP and identifier information. If the VASP cannot be found,
please input others within vasp list and the name of the exchange within vaspName field.
EU(Poland,France)
Name
Type
Mandatory
Description
depositOriginator
INTEGER
YES
1 = Myself, 2 = Not myself
orgType
INTEGER
YES *1
0 = Individual, 1 = Corporate/Entity
orgFirstName
STRING
YES *2
Originator's First Name, for more information please refer to the Name restrictions section in the appendix.
orgLastName
STRING
YES *2
Originator's Last Name, for more information please refer to the Name restrictions section in the appendix.
country
STRING
YES *2
Originator's nationality code, ISO 2 digit, lower case. For more information please refer to the Countries and Regions section in the appendix.
corpName
STRING
YES *3
Originator's (corporation) Name
corpCountry
STRING
YES *3
Originator's (corporation) nationality code, ISO 2 digit, lower case. For more information please refer to the Countries and Regions section in the appendix.
receiveFrom
INTEGER
YES
1 = Private Wallet, 2 = Another VASP
vasp
STRING
YES *4
Vasp identifier of the beneficiary
vaspName
STRING
YES *5
VASP Name
declaration
BOOLEAN
YES
Declaration confirmation
Required when depositOriginator is 2.
Required when orgType is 0.
Required when orgType is 1.
Required when receiveFrom is 2.
The Vasp List API provides the VASP and identifier information. If the VASP cannot be found,
please input others within vasp list and the name of the exchange within vaspName field.
South Africa
Name
Type
Mandatory
Description
depositOriginator
INTEGER
YES
1 = Myself, 2 = Not myself
orgType
INTEGER
YES *1
0 = Individual, 1 = Corporate/Entity
orgName
STRING
YES *2
Originator's Name, for more information please refer to the Name restrictions section in the appendix.
country
STRING
YES *2
Originator's nationality code, ISO 2 digit, lower case. For more information please refer to the Countries and Regions section in the appendix.
corpName
STRING
YES *3
Originator's (corporation) Name
corpCountry
STRING
YES *3
Originator's (corporation) nationality code, ISO 2 digit, lower case. For more information please refer to the Countries and Regions section in the appendix.
receiveFrom
INTEGER
YES
1 = Private Wallet, 2 = Another VASP
vasp
STRING
YES *4
Vasp identifier of the beneficiary
vaspName
STRING
YES *5
VASP Name
declaration
BOOLEAN
YES
Declaration confirmation
Required when depositOriginator is 2.
Required when orgType is 0.
Required when orgType is 1.
Required when receiveFrom is 2.
The Vasp List API provides the VASP and identifier information. If the VASP cannot be found,
please input others within vasp list and the name of the exchange within vaspName field.
Australia
Name
Type
Mandatory
Description
depositOriginator
INTEGER
YES
1 = Myself, 2 = Not myself
orgType
INTEGER
YES *1
0 = Individual, 1 = Corporate/Entity
orgFirstName
STRING
YES *2
Originator's First Name. For more information please refer to the Name restrictions section in the appendix.
orgLastName
STRING
YES *2
Originator's Last Name. For more information please refer to the Name restrictions section in the appendix.
country
STRING
YES *2
Originator's country code, ISO 2 digit, lower case. Obtained from Country List API.
city
STRING
YES *2
Originator's city/town. Obtained from Region List API (regionName value).
corpName
STRING
YES *3
Corporation/entity name.
corpCountry
STRING
YES *3
Corporation country code, ISO 2 digit, lower case. Obtained from Country List API.
corpCity
STRING
YES *3
Corporation city/town. Obtained from Region List API (regionName value).
identifierType
STRING
NO
See Identifier Type Options below.
identifier
STRING
YES *6
Identifier value corresponding to identifierType.
receiveFrom
INTEGER
YES
1 = Private Wallet, 2 = Another VASP
vasp
STRING
YES *4
VASP identifier of the originator
vaspName
STRING
YES *5
VASP Name
declaration
BOOLEAN
YES
Declaration confirmation
Required when depositOriginator is 2.
Required when orgType is 0(Individual).
Required when orgType is 1(Corporate/Entity).
Required when receiveFrom is 2.
Required when vasp is others.
Required when identifierType is provided.
The Vasp List API provides the VASP and identifier information. If the VASP cannot be found,
please input others within vasp list and the name of the exchange within vaspName field.
Identifier Type Options:
identifierType
Meaning
Applicable When
Validation
PASSPORT
Passport number
orgType = 0 (Individual)
Alphanumeric, 1–50 chars
NATIONAL_ID
National identity card number
orgType = 0 (Individual)
Alphanumeric, 1–50 chars
ABN
Australian Business Number
orgType = 1 (Corporate)
Exactly 11 digits
ACN
Australian Company Number
orgType = 1 (Corporate)
Exactly 9 digits
OTHER
Other registration number
orgType = 1 (Corporate)
Alphanumeric, 1–50 chars
Brazil
Name
Type
Mandatory
Description
depositOriginator
INTEGER
YES
1 = Deposited by myself, 2 = Deposited by someone else
receiveFrom
INTEGER
YES
1 = Self-hosted wallet, 2 = VASP / Exchange
vasp
STRING
YES *6
VASP identifier of the originator. Obtained from Vasp List API.
declaration
BOOLEAN
YES
Declaration confirmation, must be true.
orgType
INTEGER
YES *1
0 = Individual, 1 = Corporate/Entity
orgFirstName
STRING
YES *2
Originator's First Name.
orgLastName
STRING
YES *2
Originator's Last Name.
country
STRING
YES *2
Originator's country code, ISO 2 digit, lower case. Obtained from Country List API.
corpName
STRING
YES *3
Corporation/entity name.
corpCountry
STRING
YES *3
Corporation country code, ISO 2 digit, lower case. Obtained from Country List API.
cpf
STRING
YES *4
CPF (Brazilian individual taxpayer number). See Tax Identifier Rules below.
cnpj
STRING
YES *4
CNPJ (Brazilian corporate taxpayer number). See Tax Identifier Rules below.
individualTaxId
STRING
YES *5
Individual taxpayer identification number. See Tax Identifier Rules below.
corporateTaxId
STRING
YES *5
Corporate taxpayer identification number. See Tax Identifier Rules below.
txnPurpose
STRING
YES *7
Purpose of transaction code (e.g. 12995). For more information please refer to the Brazil Regulatory Codes section in the appendix.
counterpartyType
STRING
YES *7
Counterparty type code, sent as a string (e.g. "03"). For more information please refer to the Brazil Regulatory Codes section in the appendix.
relationship
STRING
YES *8
Relationship code, 40 or 50. For more information please refer to the Brazil Regulatory Codes section in the appendix.
Required when depositOriginator is 2.
Required when depositOriginator is 2 and orgType is 0(Individual).
Required when depositOriginator is 2 and orgType is 1(Corporate/Entity).
Required when depositOriginator is 2 and the originator country (country or
corpCountry) is br (domestic): cpf for Individual, cnpj for Corporate/Entity.
Required when depositOriginator is 2 and the originator country (country or
corpCountry) is not br (international): individualTaxId for Individual, corporateTaxId
for Corporate/Entity.
Required when receiveFrom is 2. Only VASPs returned by the Vasp List API are accepted;
others is not supported.
Required for international transfers: depositOriginator is 2 and the originator country is
not br.
Required for international transfers from a Corporate/Entity originator: depositOriginator is
2, the originator country is not br and orgType is 1.
Transaction amount cap: Cross-border deposits above USD 100,000 equivalent per transaction are
blocked with error -30106 (Transaction amount exceeds the limit.). The cap uses the
USD-equivalent value at transaction time. Deposits from self-hosted wallets and domestic (BR-to-BR)
transfers are exempt. A deposit from your own account at a VASP outside Brazil is international and
subject to the cap.
Tax Identifier Rules:
Field
Applicable When
Format
cpf
orgType = 0 (Individual) and country = br
###.###.###-## (11 digits), separators required: ^\d{3}\.\d{3}\.\d{3}-\d{2}$. Format check only, no checksum validation.
cnpj
orgType = 1 (Corporate) and corpCountry = br
##.###.###/####-## (14 digits), separators required: ^\d{2}\.\d{3}\.\d{3}/\d{4}-\d{2}$. Format check only, no checksum validation.
