1. Basic Conventions
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. Basic Conventions

Message Structure

1. request message#

http message headers
Fieldfield DescriptionTypeRequired (M)/ can select (O)value range or formatbusiness rules
x-signatureSignatureCM{Signature}non-File Upload API for entire body perform Signature; File Upload API for checksum perform Signature
x-app-idPartner apply IDCMis Partner apply assign of unique apply ID
x-request-idrequest IDCMPartner system globally unique, and business no related
http message body
Fieldfield DescriptionTypeRequired (M)/ can select (O)value range or formatbusiness rules
business Datarequest business DataCMjson formatSee specific API definition
request message example: 

POST /api/v1/ex/onboarding/merchant HTTP/1.1
Host: api.eurewax.com
Content-Type: application/json
x-signature: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
x-app-id: APP2023112700001
x-request-id: REQ20231127160523789001

{
    "orderId": "ORD20231127001",
    "orderAmount": 1000.00,
    "currency": "CNY",
    "userId": "USR10001",
    "productList": [
      {
        "productId": "PROD001",
        "quantity": 2,
        "price": 500.00
      }
    ]
}

2. synchronous response message#

http message headers
Fieldfield DescriptionTypeRequired (M)/ can select (O)value range or formatbusiness rules
x-signatureSignatureCM{Signature}for entire body perform Signature
x-app-idPartner apply IDCM
x-request-idrequest IDCM
http message body
Fieldfield DescriptionTypeRequired (M)/ can select (O)value range or formatbusiness rules
codeResponse CodeCMbusiness Processed Successfully: 0; Otherall indicates business Processing Failedbusiness processing Status
messageresponse InformationCMDescription specific Information
dataresponseDataCOjson formatSee specific API definition
Processed Success fully synchronous response example: 

HTTP/1.1 200 OK
Content-Type: application/json
x-signature: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
x-app-id: APP2023112700001
x-request-id: REQ20231127160523789001

{
  "code": "0",
  "message": "Processed Successfully",
  "data": {
    "transactionId": "TRX20231127001",
    "orderStatus": "ACCEPTED",
    "processingTime": "20230101120000",
    "details": {
      "paymentLink": "https://payment.example.com/pay/TRX20231127001",
      "expiryTime": "20230101120000"
    }
  }
}

Processing Failed synchronous response example: 

HTTP/1.1 200 OK
Content-Type: application/json
x-signature: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
x-app-id: APP2023112700001
x-request-id: REQ20231127160523789001

{
  "code": "E0010001",
  "message": "parameter Verification Failure: Order Amountnot can is empty",
  "data": null
}

3. asynchronous Notification message#

http message headers
Fieldfield DescriptionTypeRequired (M)/ can select (O)value range or formatbusiness rules
x-signatureSignatureCM{Signature}for entire body perform Signature
http message body
Fieldfield DescriptionTypeRequired (M)/ can select (O)value range or formatbusiness rules
business Dataasynchronous Notification of Result business DataCMjson formatSee specific Notification API definition
asynchronous Notification message example: 

POST /api/callback/payment HTTP/1.1
Host: partner.example.com
Content-Type: application/json
x-signature: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

{
    "notifyType": "PAYMENT_STATUS",
    "orderId": "ORD20231127001",
    "transactionId": "TRX20231127001",
    "orderStatus": "PAID",
    "paymentAmount": 1000.00,
    "paymentTime": "20230101120000",
    "paymentMethod": "WECHAT",
    "notifyId": "NOT20231127001",
    "notifyTime": "20230101120000"
}


Modified at 2026-08-08 08:28:31
Previous
Global Conventions
Next
Signature
Built with