1. Appendix
EurewaX Open API
  • Basic Conventions
    • Global Conventions
    • Message Structure
    • Signature
    • Encryption
  • Interaction Flow
    • Business Application Flow
  • Business APIs
    • 1 Common Services
      • 1.1 Event Notifications
        • Configure NotificationURL
      • 1.2 File Service
        • Upload File
        • supplementary business Document
      • 1.3 Authentication Service
        • Get Merchant Token
    • 2 Onboarding Services
      • 2.1 Merchant Onboarding
        • Register Merchant
        • KYCApply for
        • KYBApply for
        • Query KYCReview Result
        • KYCReview ResultNotification
        • Query KYBReview Result
        • KYBReview ResultNotification
        • Get can open through Product List
    • 3 Fiat Services
      • 3.1 Collection Services
        • 3.1.1 Collection Store Management
          • Get Platform Site
          • Add Store Owner
          • Bind Store
          • Query Store Information
        • 3.1.2 VA Account Services
          • Apply for VAAccount Number
          • Download Account OpeningCertificate
          • Query VAAccount Number
          • VAAccount NumberChange Notification
        • 3.1.3 Collection Transaction Processing
          • Collection Crediting Notification
      • 3.2 Payment Services
        • 3.2.1 Payee Management
          • Add Payee
          • Delete Payee
          • Query Payee Review Result
          • Payee Review ResultNotification
        • 3.2.2 Payment Transaction Processing
          • Single Payment
          • Payment ResultNotification
        • 3.2.3 Settlement Quota Management
          • Query FX Settlement Quota
          • Upload FX Settlement Document
          • Query FX Settlement Document Review Result
          • FX Settlement Document Review ResultNotification
      • 3.3 Foreign Exchange Services
        • Query Merchant Exchange Rate
        • Merchant FX Quote
        • Real-time FX
      • 3.4 Account Services
        • 3.4.1 Account Management
          • Account Query
          • Account Authorization
          • Cancel authorization
        • 3.4.2 Account Transactions
          • Account Transfer
          • Batch Transfer
          • Funds Pooling
          • Funds PoolingResultNotification
          • Batch TransferResultNotification
          • Per-transaction TransferResultNotification
      • 3.5 Transaction Queries
        • 3.5.1 Transaction Details
          • Funds PoolingTransaction Details
          • Payment Transaction Details
          • Collection Transaction Details
          • TransferTransaction Details
          • FX Exchange Transaction Details
        • Download Transaction Certificate
        • Query Transaction Details
    • 4 Crypto Services
      • 4.1 Basic Functions
        • Query Exchange Rate
        • Query Supported of asset
      • 4.2 Account Management
        • Query Account List
      • 4.3 Collection Instrument Management
        • Query Collection Instrument
      • 4.4 Payee Management
        • Add Payee
        • Delete Payee
        • Query Payee List
        • Payee Review ResultNotification
      • 4.5 Transaction Management
        • Fiat Deposit
          • Fiat Deposit
        • Fiat Withdrawal
          • Fiat Withdrawal
        • Crypto Deposit
          • Crypto Deposit
        • Crypto Withdrawal
          • Crypto Withdrawal
        • Crypto Buy
          • Get Crypto Buy Quote
          • Buy Crypto
        • Crypto Sell
          • Get Crypto Sell Quote
          • Sell Crypto
        • Fiat convert Crypto
          • Get fiat-to-cryptoQuote
          • Fiat convert Crypto
        • Crypto convert Fiat
          • Get crypto-to-fiatQuote
          • Crypto convert Fiat
        • Deposit/WithdrawalTransaction Fee estimate
        • Query Transaction Details
        • Query Transaction record
        • Transaction ResultNotification
    • 5 VCC Services
      • 5.1 Card Application Services
        • Query Product List
        • Virtual Card Apply for
        • Query Apply for Details
        • Card Apply for ResultNotification
      • 5.2 Card Information Query Services
        • Query Card CVV
        • Query Card Information
        • Query Card Balance
      • 5.3 Card Management Services
        • Unfreeze Card
        • Activate Card
        • Cancel Card
        • Freeze Card
        • Update Card Limit
        • Update Cardholder
        • Card StatusChange Notification
      • 5.4 Card Transaction Services
        • Funds Transfer In
        • Funds Transfer Out
        • Query non-authorization Transaction Details
        • Query Transaction List
        • Query Card Funds Details
        • Card Transaction ResultNotification
        • Card 3DSVerificationNotification
    • 6 Unified Checkout
      • Create Order
      • Query Order Details
      • Payment ResultNotification
  • Integration Testing
    • Overall Flow
    • Environment Parameters
  • Appendix
    • Enum Type
    • KYCtemplate
    • KYBtemplate
  • Schemas
    • TransferOrder
  1. Appendix

Enum Type

Entity Type#

codeDescription
enterpriseEnterprise
personalIndividual

Legal Representative Type#

codeDescription
UBOUltimate Beneficial Owner
directorDirector
authSignerAuthorized Signer
legalPersonLegal Representative

Member AccountStatus#

codeDescription
PROCESSINGProcessing
OPENNormal
CLOSEDClosed
FAILEDActivation Failed

ID Document Type#

codeDescription
idCardNational ID Card
passportPassport
business_licenseBusiness License
otherOther

Business Domain#

codeDescriptionBusiness Line
amazonPlatformAmazon E-commerce PlatformCOLLECTION_B2C
eBayPlatformeBay E-commerce PlatformCOLLECTION_B2C
otherEPOtherE-commerce PlatformCOLLECTION_B2C
overseasCollectionOverseas CollectionCOLLECTION_B2C
selfbuiltStationIndependent WebsiteCOLLECTION_B2C
aboAffiliate NetworkCOLLECTION_B2C
softwareDevelopmentDeveloper PlatformCOLLECTION_B2C
goodsTrade in GoodsCOLLECTION_B2B
logisticsServiceCollectionLogistics ServicesCOLLECTION_B2B

industryCategory#

English NameDescription
AgricultureAgriculture
ConstructionAndRealEstateconstruction and real estate (combined and category term, covering construction and real estaterelated business )
EducationEducation
Energycan Source (including pass conventional can Source , new can Source etc.fields)
FinancialServicesfinancial service (if Bank , insurance, investmentetc.business )
FoodAndBeveragefood product and beverage
GovernmentAndNonprofitgovernment and non-business profit organization
HealthcareHealthcare (including medical servicesservice, pharmaceuticals, health managementetc.)
InformationTechnologyInformationTechnology (abbreviated as IT, including software , hardware, internetserviceetc.)
ManufacturingManufacturing
MediaAndEntertainmentmedia and Entertainment
ProfessionalServicesprofessional service (if legal , consulting, will accountingetc.knowledge-based service)
RetailRetail
TransportationAndLogisticstransportation and logistics
TravelAndHospitalitytravel and hospitality (including travelservice, hotel accommodation, food servicereceive pending etc.)
OtherOther (used for categorize not explicitly listed output of industry)

Occupation#

codeDescription
10600enterprise and institution employmentorder-digit manager people
20100scientific research people worker
20600economics and finance professional people worker
20700legal , social and religious professional people worker
20800education people worker
21000news and publishing, cultural professional people worker
29900Otherprofessional Technology people worker
40300accommodation and food serviceservice people worker
40400Informationtransportation , software and InformationTechnical Services people worker
40500financial service people worker
40600real estateservice people worker
40700leasing and businessservice people worker
40800Technologysupport service people worker
40100wholesale and retailservice people worker
41000communityservice people worker
49900Othersocial production and personal servicesservice people worker
99999school-age before child, Student, Unemployed, no employment or retired

Transaction Amount#

codeDescription
PAYMENTPayment Amount
RECEIVEDReceived Amount

Transaction Status#

codeDescription
PROCESSINGProcessing
PUT_BACKAdditional Documents Required
SUCCESSProcessed Successfully
FAILEDProcessing Failed
REFUNDEDalready Returned Payment
CLOSEDClosed

Review Status#

codeDescription
PROCESSINGUnder Review
SUCCESSApproved
FAILEDRejected
PUT_BACKAdditional Documents Required
FORBIDDENForbidden

Payee CategoryList#

CODEDescription
ADVESadvertiser
CARGOfreight forwarder
EMPLemployee
GODSsupplier
LOGSlogistics provider
TXAGtax agent/tax authority
TXBUtax authority
WAREwarehouse provider
WITHDRAWWithdrawal
OTHEROther

Recipient method#

CODEDescription
LOCALLocal Collection
SWIFTSWIFT Collection

CurrencyList#

codeDescription
AUDAustralian Dollar
CADCanadian Dollar
CHFSwiss Franc
CNHOffshore Renminbi
CNYRenminbi
EUREuro
GBPPound Sterling
HKDHong Kong Dollar
IDRRupiah
INRIndian Rupee
JPYJapanese Yen
KRWSouth Korean Won
MYRMalaysian Ringgit
NZDNew Zealand Dollar
PHPPhilippine Peso
SGDSingapore Dollar
THBThai Baht
USDUS Dollar
VNDVietnamese Dong
USDTUSDT
USDCUSDC

Transaction Type#

CategorycodeDescription
onboarding servicesKYCKYCApply for
onboarding servicesKYBKYBApply for
Fiat ServicesFOUND_OUTPayment
Fiat ServicesFOUND_INCollection
Fiat ServicesTRANSFERwalletTransfer
Fiat ServicesPOOLINGFunds Pooling
Fiat ServicesFXFX Exchange
Fiat ServicesVAApply for VA
Fiat ServicesPAYEEAdd Payee
Fiat ServicesPAYEE_DELDelete Payee
Fiat ServicesSHOP_BINDStore Bind
Fiat ServicesSHOP_UNBINDStore unbind
Fiat ServicesHOLDER_BINDStore Owner Bind
Fiat ServicesHOLDER_UNBINDStore Owner unbind
Fiat ServicesAUTHAccount Authorization
Fiat ServicesUN_AUTHCancel authorization
Crypto ServicesCR_PAYEEAdd Payee
Crypto ServicesCR_PAYEE_DELDelete Payee
Crypto ServicesCR_FIAT_DEPOSITFiat Deposit
Crypto ServicesCR_FIAT_WITHDRAWFiat Withdrawal
Crypto ServicesCR_CRYPTO_DEPOSITCrypto Deposit
Crypto ServicesCR_CRYPTO_WITHDRAWCrypto Withdrawal
Crypto ServicesCR_CRYPTO_BUYCrypto Buy
Crypto ServicesCR_CRYPTO_SELLCrypto Sell
Crypto ServicesCR_FIAT_TO_CRYPTOfiat-to-crypto
Crypto ServicesCR_CRYPTO_TO_FIATcrypto-to-fiat
VCC ServicesVCC_APPLYVirtual Card Apply for
VCC ServicesVCC_ACTIVATEActivate Card
VCC ServicesVCC_SUSPENDSuspend Card
VCC ServicesVCC_REPORT_LOSTReport Lost Card
VCC ServicesVCC_FREEZEFreeze Card
VCC ServicesVCC_UNSUSPENDUnsuspend
VCC ServicesVCC_CANCEL_LOSTCancel Lost Status
VCC ServicesVCC_UNFREEZEUnfreeze Card
VCC ServicesVCC_CANCELCancel Card
VCC ServicesVCC_ADJUST_LIMITAdjust Card Limit
VCC ServicesVCC_CARD_STATUE_CHANGECard StatusChange
VCC ServicesVCC_UPDATE_HOLDERUpdate Cardholder
VCC ServicesVCC_TRANSFER_INFunds Transfer In
VCC ServicesVCC_TRANSFER_OUTFunds Transfer Out
VCC ServicesVCC_VERIFICATIONauthorizationVerification
VCC ServicesVCC_CONSUMPTIONPurchase
VCC ServicesVCC_CONSUMPTION_REFUNDRefund
VCC ServicesVCC_CONSUMPTION_CANCELReversal
VCC ServicesVCC_CONSUMPTION_CLEARClearing
VCC ServicesVCC_CONSUMPTION_DECLINEreject
VCC ServicesVCC_CHARGEBACKChargeback
VCC ServicesVCC_3DS_OPT3DSVerification

Account Authorizationpermissions#

codeDescription
POOLING_ALL_AMOUNTAll AmountPooling
POOLING_PARTIAL_AMOUNTPartial AmountPooling

Funds Account Status#

codeDescription
NO_INCOMINGIncoming Disabled
NO_OUTGOINGOutgoing Disabled
NORMALNormal

Sales Category#

codeDescription
1001Automotive Parts and Industrial Supplies
1002Beauty, Personal Care and Health
1003Clothing, Footwear, Hats, and Accessories
1004Consumer Electronics
1005Furniture, Garden and Pet Supplies
1006Office, School Supplies
1007Sports, Outdoor Goods
1008Tools, Home-improvement Supplies
1009Toys, Maternity and Baby Products
1010Jewelry, Antiques, Art
1011Gift CardsCard , Games, Virtual Goods
1012General MerchandiseProduct
1013Other

business Type#

codeDescription
COLLECTION_B2CPlatform Collection Service
COLLECTION_B2BCross-border Trade Collection Service

Platform Type#

codeDescription
B2BB2BPlatform
B2CB2CPlatform

Payment Purpose#

codeDescription
ADVERTISEMENTAdvertising and Marketing
EDUCATION_TRAININGEducation/Training
LOGISTICS_COSTLogistics Costs
OPERATING_COSTOperating Costs
PURCHASE_GOODSPurchase of Goods
TECHNICAL_SERVICESTechnical Services
TRANSFER_SELF_ACCOUNTTransfer to Own Account
OTHEROther

Collection SiteType#

codeDescription
PLAT_COLLECTIONPlatform Collection
INDEPENDENT_STATIONIndependent Website Collection
SOFTWARE_COLLECTIONDeveloper Platform Collection
MARKETING_COLLECTIONAffiliate Network Collection

Platform Number#

codeDescriptionPlatform Type
101AmazonNorth AmericaPlatform Collection
103AmazonEurope sitePlatform Collection
104AmazonUnited Kingdom sitePlatform Collection
105AmazonJapan sitePlatform Collection
107AmazonAustraliaPlatform Collection
108AmazonUnited Arab Emirates sitePlatform Collection
109AmazonSaudi ArabiaPlatform Collection
102eBayNorth AmericaPlatform Collection
203eBayEurope sitePlatform Collection
204eBayUnited Kingdom sitePlatform Collection
205eBayAustraliaPlatform Collection
401SouqSaudi ArabiaPlatform Collection
402SouqUnited Arab Emirates sitePlatform Collection
501Noon in East sitePlatform Collection
502NoonSaudi ArabiaPlatform Collection
503NoonUnited Arab Emirates sitePlatform Collection
601ShopifyPlatform Collection
701CdiscountPlatform Collection
801ShopeePlatform Collection
1801TikTokPlatform Collection
901OtherE-commerce PlatformPlatform Collection
1101OnBuyPlatform Collection
1201ShoplazzaPlatform Collection
1901Google PlayPlatform Collection
1902Google AdsensePlatform Collection
1903Google AdmobPlatform Collection
1904Apple StorePlatform Collection
1905SteamPlatform Collection
1906Othersoftware PlatformPlatform Collection
2001Mercado librePlatform Collection
2002EtsyPlatform Collection
2003AliExpressPlatform Collection
2004BigcommercePlatform Collection
2005ShopyyPlatform Collection
2006XShoppyPlatform Collection
2007UeeshopPlatform Collection
2008WoocommercePlatform Collection
2009ShoplinePlatform Collection
2010OtherIndependent WebsitePlatform Collection
2011tax authorityRemittancePlatform Collection
2012WayfairPlatform Collection
2101Overseas CollectionPlatform Collection

Store Register Type#

codeDescription
UnifiedSocialCreditIdUnified Social Credit Identifier (Taxpayer Identification Number)
CompanyRegistrationNoCompany Registration Number

Account Numberlocated in Country/RegionList#

codeDescription
CNChina
HKHong Kong SAR China
USUnited States
GBUnited Kingdom
EUEurope
SGSingapore
JPJapan
AEUnited Arab Emirates
SASaudi Arabia
AUAustralia
EEEstonia
IDIndonesia

CountryList#

codeName
HKHong Kong SAR China
MOMacao SAR China
TWTaiwan
EUEurope
DZAlgeria
AFAfghanistan
ARArgentina
AEUnited Arab Emirates
AWAruba
OMOman
AZAzerbaijan
EGEgypt
ETEthiopia
IEIreland
EEEstonia
ADAndorra
AOAngola
AIAnguilla
AGAntigua & Barbuda
AUAustralia
ATAustria
AXÅland Islands
BBBarbados
PGPapua New Guinea
BSBahamas
PKPakistan
PYParaguay
PSPalestinian Territories
BHBahrain
PAPanama
BRBrazil
BYBelarus
BMBermuda
BGBulgaria
MPNorthern Mariana Islands
BJBenin
BEBelgium
ISIceland
PRPuerto Rico
PLPoland
BOBolivia
BABosnia & Herzegovina
BWBotswana
BZBelize
BTBhutan
BFBurkina Faso
BIBurundi
BVBouvet Island
DKDenmark
DEGermany
TLTimor-Leste
TGTogo
DODominican Republic
RURussia
ECEcuador
EREritrea
FRFrance
FOFaroe Islands
PFFrench Polynesia
GFFrench Guiana
TFFrench Southern Territories
VAVatican City
PHPhilippines
FJFiji
FIFinland
CVCape Verde
FKFalkland Islands
GMGambia
CGCongo - Brazzaville
COColombia
CRCosta Rica
GGGuernsey
GDGrenada
GLGreenland
GPGuadeloupe
GUGuam
GYGuyana
KZKazakhstan
HTHaiti
KRSouth Korea
NLNetherlands
ANCuraçao
HMHeard & McDonald Islands
HNHonduras
KIKiribati
DJDjibouti
KGKyrgyzstan
GNGuinea
GWGuinea-Bissau
CACanada
GHGhana
GAGabon
CNChina
ALAlbania
KHCambodia
CZCzechia
ZWZimbabwe
CMCameroon
QAQatar
KYCayman Islands
CCCocos (Keeling) Islands
KMComoros
CICôte d’Ivoire
KWKuwait
HRCroatia
KEKenya
CKCook Islands
LVLatvia
LSLesotho
LALaos
LBLebanon
LRLiberia
LYLibya
LTLithuania
LILiechtenstein
RERéunion
LULuxembourg
RWRwanda
RORomania
MGMadagascar
MVMaldives
MTMalta
MWMalawi
MYMalaysia
MLMali
MKNorth Macedonia
MHMarshall Islands
MQMartinique
YTMayotte
IMIsle of Man
MUMauritius
MRMauritania
USUnited States
ASAmerican Samoa
UMU.S. Outlying Islands
MNMongolia
MSMontserrat
BDBangladesh
FMMicronesia
PEPeru
MMMyanmar (Burma)
MDMoldova
MAMorocco
MCMonaco
MZMozambique
MXMexico
NANamibia
ZASouth Africa
GSSouth Georgia & South Sandwich Islands
NRNauru
NPNepal
NINicaragua
NENiger
NGNigeria
NUNiue
NONorway
NFNorfolk Island
PWPalau
PNPitcairn Islands
PTPortugal
GEGeorgia
JPJapan
SESweden
CHSwitzerland
SVEl Salvador
WSSamoa
MEMontenegro
SLSierra Leone
SNSenegal
CYCyprus
SCSeychelles
SASaudi Arabia
CXChristmas Island
STSão Tomé & Príncipe
SHSt. Helena
KNSt. Kitts & Nevis
LCSt. Lucia
SMSan Marino
PMSt. Pierre & Miquelon
VCSt. Vincent & Grenadines
LKSri Lanka
SKSlovakia
SISlovenia
SJSvalbard & Jan Mayen
SZEswatini
SRSuriname
SBSolomon Islands
SOSomalia
TJTajikistan
THThailand
TZTanzania
TOTonga
TCTurks & Caicos Islands
TTTrinidad & Tobago
TNTunisia
TVTuvalu
TRTürkiye
TMTurkmenistan
TKTokelau
WFWallis & Futuna
VUVanuatu
GTGuatemala
VIU.S. Virgin Islands
VGBritish Virgin Islands
VEVenezuela
BNBrunei
UGUganda
UYUruguay
UZUzbekistan
ESSpain
GRGreece
SGSingapore
NCNew Caledonia
NZNew Zealand
HUHungary
JMJamaica
AMArmenia
YEYemen
IQIraq
ILIsrael
ITItaly
INIndia
IDIndonesia
GBUnited Kingdom
IOBritish Indian Ocean Territory
JOJordan
VNVietnam
ZMZambia
JEJersey
TDChad
GIGibraltar
CLChile
CFCentral African Republic

Network Code(NetworkCode)#

valueDescriptionCurrency
ERC-20EthereumNetworkUSDT, USDC
TRC-20TRONNetworkUSDT

VCCCard Status#

CodeDescription
NORMALNormal
FROZENFreeze
EXPIREDExpiration
CLOSEDCancel
INACTIVEpending Activate
LOCKINGlock (only allows Deposit)

VCCFee item#

CODEDescription
VCC_OPEN_CARDvcc-open Card
VCC_RECHARGEvcc-Deposit
VCC_CARD_MANAGEMENT_FEEvcc-managementfee
VCC_WITHDRAWvcc-Withdrawal
VCC_TRANSACTIONvcc-Preauthorization Purchase
VCC_CANCELLATIONvcc-Card Cancel
VCC_REBATEvcc-Rebate
VCC_REFUNDvcc-Transaction (Refund)
VCC_CHARGEBACKvcc-Transaction (Chargeback)
VCC_TRANSACTION_FAILvcc-Transaction (Failure)
VCC_VERIFICATIONvcc-open Card Verification

VCCCard Type#

CODEDescription
PREPAIDDepositCard
SHAREDsharedCard

Crypto Fee Type#

CODEDescription
1001Crypto DepositProcessing Fee
2006ReversalProcessing Fee
20113DSVerificationfee
2008Freeze Unfreeze Processing Fee
2009DisputeProcessing Fee
2010ApplePay/GooglePayProcessing Fee
2007RefundProcessing Fee
1005Fiat DepositProcessing Fee
1006Fiat WithdrawalProcessing Fee
1007Fiat-to-cryptoProcessing Fee
1008Crypto-to-fiatProcessing Fee
1002Crypto WithdrawalProcessing Fee
1003Sell Crypto Processing Fee
1004Buy Crypto Processing Fee
2001open Card fee
2002monthfee
2003Depositfee
2004Small-transaction Transaction Processing Fee
2005reject Processing Fee

***Crypto Funds Source ***#

CODEDescription
otcOTC Transaction
SalaryIncomeSalary Income
ExchangeWithdrawalTransaction exchange withdrawal
BusinessIncomeBusiness Income
InvestmentIncomeInvestment Income
MiningIncomeMining Income
OtherOther

Crypto Funds Purpose#

CODEDescription
CryptocurrencyExchangeExchange EncryptionCurrency
SupplierPaymentsupplierPayment
OperatingCostsOperating Costs
OtherOther
Modified at 2026-08-08 08:08:06
Previous
Environment Parameters
Next
KYCtemplate
Built with