Common Types
Reference page with common types used across the SDK services interfaces
Common Structures
UserSessionData
Field Name | Type |
---|---|
userUuid | string |
unblockSessionId | string |
Union Types
Literal Types
Enums
Country
enum Country {
Afghanistan = 'AF',
AlandIslands = 'AX',
Albania = 'AL',
Algeria = 'DZ',
AmericanSamoa = 'AS',
Andorra = 'AD',
Angola = 'AO',
Anguilla = 'AI',
Antarctica = 'AQ',
AntiguaAndBarbuda = 'AG',
Argentina = 'AR',
Armenia = 'AM',
Aruba = 'AW',
Australia = 'AU',
Austria = 'AT',
Azerbaijan = 'AZ',
Bahamas = 'BS',
Bahrain = 'BH',
Bangladesh = 'BD',
Barbados = 'BB',
Belarus = 'BY',
Belgium = 'BE',
Belize = 'BZ',
Benin = 'BJ',
Bermuda = 'BM',
Bhutan = 'BT',
Bolivia = 'BO',
BonaireSintEustatiusSaba = 'BQ',
BosniaAndHerzegovina = 'BA',
Botswana = 'BW',
BouvetIsland = 'BV',
Brazil = 'BR',
BritishIndianOceanTerritory = 'IO',
BruneiDarussalam = 'BN',
Bulgaria = 'BG',
BurkinaFaso = 'BF',
Burundi = 'BI',
Cambodia = 'KH',
Cameroon = 'CM',
Canada = 'CA',
CapeVerde = 'CV',
CaymanIslands = 'KY',
CentralAfricanRepublic = 'CF',
Chad = 'TD',
Chile = 'CL',
China = 'CN',
ChristmasIsland = 'CX',
CocosKeelingIslands = 'CC',
Colombia = 'CO',
Comoros = 'KM',
Congo = 'CG',
CongoDemocraticRepublic = 'CD',
CookIslands = 'CK',
CostaRica = 'CR',
CoteDIvoire = 'CI',
Croatia = 'HR',
Cuba = 'CU',
Curaçao = 'CW',
Cyprus = 'CY',
CzechRepublic = 'CZ',
Denmark = 'DK',
Djibouti = 'DJ',
Dominica = 'DM',
DominicanRepublic = 'DO',
Ecuador = 'EC',
Egypt = 'EG',
ElSalvador = 'SV',
EquatorialGuinea = 'GQ',
Eritrea = 'ER',
Estonia = 'EE',
Ethiopia = 'ET',
FalklandIslands = 'FK',
FaroeIslands = 'FO',
Fiji = 'FJ',
Finland = 'FI',
France = 'FR',
FrenchGuiana = 'GF',
FrenchPolynesia = 'PF',
FrenchSouthernTerritories = 'TF',
Gabon = 'GA',
Gambia = 'GM',
Georgia = 'GE',
Germany = 'DE',
Ghana = 'GH',
Gibraltar = 'GI',
Greece = 'GR',
Greenland = 'GL',
Grenada = 'GD',
Guadeloupe = 'GP',
Guam = 'GU',
Guatemala = 'GT',
Guernsey = 'GG',
Guinea = 'GN',
GuineaBissau = 'GW',
Guyana = 'GY',
Haiti = 'HT',
HeardIslandMcdonaldIslands = 'HM',
HolySeeVaticanCityState = 'VA',
Honduras = 'HN',
HongKong = 'HK',
Hungary = 'HU',
Iceland = 'IS',
India = 'IN',
Indonesia = 'ID',
Iran = 'IR',
Iraq = 'IQ',
Ireland = 'IE',
IsleOfMan = 'IM',
Israel = 'IL',
Italy = 'IT',
Jamaica = 'JM',
Japan = 'JP',
Jersey = 'JE',
Jordan = 'JO',
Kazakhstan = 'KZ',
Kenya = 'KE',
Kiribati = 'KI',
Korea = 'KR',
KoreaDemocraticPeoplesRepublic = 'KP',
Kuwait = 'KW',
Kyrgyzstan = 'KG',
LaoPeoplesDemocraticRepublic = 'LA',
Latvia = 'LV',
Lebanon = 'LB',
Lesotho = 'LS',
Liberia = 'LR',
LibyanArabJamahiriya = 'LY',
Liechtenstein = 'LI',
Lithuania = 'LT',
Luxembourg = 'LU',
Macao = 'MO',
Macedonia = 'MK',
Madagascar = 'MG',
Malawi = 'MW',
Malaysia = 'MY',
Maldives = 'MV',
Mali = 'ML',
Malta = 'MT',
MarshallIslands = 'MH',
Martinique = 'MQ',
Mauritania = 'MR',
Mauritius = 'MU',
Mayotte = 'YT',
Mexico = 'MX',
Micronesia = 'FM',
Moldova = 'MD',
Monaco = 'MC',
Mongolia = 'MN',
Montenegro = 'ME',
Montserrat = 'MS',
Morocco = 'MA',
Mozambique = 'MZ',
Myanmar = 'MM',
Namibia = 'NA',
Nauru = 'NR',
Nepal = 'NP',
Netherlands = 'NL',
NewCaledonia = 'NC',
NewZealand = 'NZ',
Nicaragua = 'NI',
Niger = 'NE',
Nigeria = 'NG',
Niue = 'NU',
NorfolkIsland = 'NF',
NorthernMarianaIslands = 'MP',
Norway = 'NO',
Oman = 'OM',
Pakistan = 'PK',
Palau = 'PW',
PalestinianTerritory = 'PS',
Panama = 'PA',
PapuaNewGuinea = 'PG',
Paraguay = 'PY',
Peru = 'PE',
Philippines = 'PH',
Pitcairn = 'PN',
Poland = 'PL',
Portugal = 'PT',
PuertoRico = 'PR',
Qatar = 'QA',
Reunion = 'RE',
Romania = 'RO',
RussianFederation = 'RU',
Rwanda = 'RW',
SaintBarthelemy = 'BL',
SaintHelena = 'SH',
SaintKittsAndNevis = 'KN',
SaintLucia = 'LC',
SaintMartin = 'MF',
SaintPierreAndMiquelon = 'PM',
SaintVincentAndGrenadines = 'VC',
Samoa = 'WS',
SanMarino = 'SM',
SaoTomeAndPrincipe = 'ST',
SaudiArabia = 'SA',
Senegal = 'SN',
Serbia = 'RS',
Seychelles = 'SC',
SierraLeone = 'SL',
Singapore = 'SG',
SintMaarten = 'SX',
Slovakia = 'SK',
Slovenia = 'SI',
SolomonIslands = 'SB',
Somalia = 'SO',
SouthAfrica = 'ZA',
SouthGeorgiaAndSandwichIsl = 'GS',
SouthSudan = 'SS',
Spain = 'ES',
SriLanka = 'LK',
Sudan = 'SD',
Suriname = 'SR',
SvalbardAndJanMayen = 'SJ',
Swaziland = 'SZ',
Sweden = 'SE',
Switzerland = 'CH',
SyrianArabRepublic = 'SY',
Taiwan = 'TW',
Tajikistan = 'TJ',
Tanzania = 'TZ',
Thailand = 'TH',
TimorLeste = 'TL',
Togo = 'TG',
Tokelau = 'TK',
Tonga = 'TO',
TrinidadAndTobago = 'TT',
Tunisia = 'TN',
Turkey = 'TR',
Turkmenistan = 'TM',
TurksAndCaicosIslands = 'TC',
Tuvalu = 'TV',
Uganda = 'UG',
Ukraine = 'UA',
UnitedArabEmirates = 'AE',
UnitedKingdom = 'GB',
UnitedStates = 'US',
UnitedStatesOutlyingIslands = 'UM',
Uruguay = 'UY',
Uzbekistan = 'UZ',
Vanuatu = 'VU',
Venezuela = 'VE',
Vietnam = 'VN',
VirginIslandsBritish = 'VG',
VirginIslandsUS = 'VI',
WallisAndFutuna = 'WF',
WesternSahara = 'EH',
Yemen = 'YE',
Zambia = 'ZM',
Zimbabwe = 'ZW',
}
Currency
enum Currency {
EURO = 'EUR',
GBP = 'GBP',
USD = 'USD',
}
ProcessStatus
enum ProcessStatus {
FC_INITIATED = 'FC_INITIATED',
FC_WAITING = 'FC_WAITING',
FC_MATCHED = 'FC_MATCHED',
AML_CHECKS_FAILED = 'AML_CHECKS_FAILED',
AML_CHECKS_IN_PROGRESS = 'AML_CHECKS_IN_PROGRESS',
AML_CHECKS_COMPLETED = 'AML_CHECKS_COMPLETED',
AML_CHECKS_REJECTED = 'AML_CHECKS_REJECTED',
CRYPTO_TRANSFER_FAILED = 'CRYPTO_TRANSFER_FAILED',
CRYPTO_TRANSFER_IN_PROGRESS = 'CRYPTO_TRANSFER_IN_PROGRESS',
CRYPTO_TRANSFER_ISSUED = 'CRYPTO_TRANSFER_ISSUED',
CRYPTO_TRANSFER_COMPLETED = 'CRYPTO_TRANSFER_COMPLETED',
CRYPTO_TRANSFER_NOT_STARTED = 'CRYPTO_TRANSFER_NOT_STARTED',
INTERLEDGER_TRANSFER_FAILED = 'INTERLEDGER_TRANSFER_FAILED',
INTERLEDGER_TRANSFER_IN_PROGRESS = 'INTERLEDGER_TRANSFER_IN_PROGRESS',
INTERLEDGER_TRANSFER_ISSUED = 'INTERLEDGER_TRANSFER_ISSUED',
INTERLEDGER_TRANSFER_COMPLETED = 'INTERLEDGER_TRANSFER_COMPLETED',
FIAT_TRANSFER_FAILED = 'FIAT_TRANSFER_FAILED',
FIAT_TRANSFER_IN_PROGRESS = 'FIAT_TRANSFER_IN_PROGRESS',
FIAT_TRANSFER_ISSUED = 'FIAT_TRANSFER_ISSUED',
FIAT_TRANSFER_COMPLETED = 'FIAT_TRANSFER_COMPLETED',
ON_HOLD_KYC = 'ON_HOLD_KYC',
ON_HOLD_PROCESS = 'ON_HOLD_PROCESS',
REFUND_LACK_KYC = 'REFUND_LACK_KYC',
OUTSIDE_TRANSFER_IN_REVIEW = 'OUTSIDE_TRANSFER_IN_REVIEW',
OUTSIDE_TRANSFER_REJECTED = 'OUTSIDE_TRANSFER_REJECTED',
OUTSIDE_TRANSFER_APPROVED = 'OUTSIDE_TRANSFER_APPROVED',
OUTSIDE_TRANSFER_RECEIVED = 'OUTSIDE_TRANSFER_RECEIVED',
FINALIZE_PROCESS_FAILED = 'FINALIZE_PROCESS_FAILED',
PROCESS_BLOCKED = 'PROCESS_BLOCKED',
PROCESS_COMPLETED = 'PROCESS_COMPLETED',
PROCESS_INITIATION_FAILED = 'PROCESS_INITIATION_FAILED',
RETURNED_LACK_KYC = 'RETURNED_LACK_KYC',
}
PaymentMethods
enum PaymentMethods {
OPEN_PAYD_BANK_TRANSFER = 'OPEN_PAYD_BANK_TRANSFER',
}
ProcessDirection
enum ProcessDirection {
ONRAMP = 'ONRAMP',
OFFRAMP = 'OFFRAMP',
}
Chain
enum Chain {
POLYGON = 'polygon',
CELO = 'celo',
OPTIMISM = 'optimism',
MAINNET = 'mainnet',
ARBITRUM = 'arbitrum',
}
CompanyType
enum CompanyType {
LIMITED_LIABILITY = 'LIMITED_LIABILITY',
SOLE_TRADER = 'SOLE_TRADER',
PARTNERSHIP = 'PARTNERSHIP',
PUBLIC_LIMITED_COMPANY = 'PUBLIC_LIMITED_COMPANY',
JOINT_STOCK_COMPANY = 'JOINT_STOCK_COMPANY',
CHARITY = 'CHARITY',
}
UserCompanyRole
enum UserCompanyRole {
ADMINISTARTOR = 'ADMINISTARTOR',
}
List of Services Available
Updated 5 months ago