1. 01 Preparations
YUNMO-API
  • API
    • 01 Preparations
      • 1.1 Protocol Specification
      • 1.2 Appendix
      • 1.3 Login authorization
        POST
    • 02 Customer
      • 2.1 Create Customer
      • 2.2 Query customer information
    • 03 KYC
      • 3.1 Submit KYC Information
      • 3.2 Get Liveness H5 Link
      • 3.3 Query Liveness Results
      • 3.4 Querying KYC Status
    • 04 Card
      • 4.01 Query available card samples
      • 4.02 Create virtual card
      • 4.03 Query customer card
      • 4.04 Customer card balance adjustment
      • 4.05 Customer card top-up order query
      • 4.06 Query customer card detail
      • 4.07 Destroy card
      • 4.08 Freeze card
      • 4.09 Unfreeze card
      • 4.10 Query card PAN-HTML
      • 4.11 Query card PAN
      • 4.12 Query card PIN
      • 4.13 Update phone number
      • 4.14 Update email
      • 4.15 Update card limit
      • 4.16 Bind physical card
      • 4.17 Activate physical card
    • 05 Transaction
      • 5.1 3DS Authorization Confirmation
    • 06 Webhook
      • 6.1 Notification Specification
      • 6.2 KYC callback
      • 6.3 3DS Notification
      • 6.4 Transaction Notification
    • Schemas
      • GetTokenVo
      • ApiResponse«GetTokenVo»
      • ApiRequest«GetTokenDto»
      • ApiRequest«CreateCardDto»
      • ApiRequest«CardRechargeDto»
      • ApiRequest«RechargeOrderQueryDto»
      • ApiRequest«CardDetailDto»
      • ApiRequest«CardStatusUpdateDto»
      • ApiRequest«CardPanHtmlDto»
      • ApiRequest«CardPanEncryptDto»
      • ApiRequest«CardQueryPinDto»
      • ApiRequest«CardPhoneDto»
      • ApiRequest«CardEmailDto»
      • ApiRequest«CardTradeLimitDto»
      • ApiRequest«BindCardDto»
      • ApiRequest«ActiveCardDto»
      • ApiRequest«CustomerAddDto»
      • ApiRequest«CustomerQueryDto»
      • ApiRequest«GetLivenessUrlDto»
      • ApiRequest«GetLivenessResultDto»
      • ApiRequest«KycDto»
      • ApiRequest«Confirm3DSDto»
      • CardSampleInfoVo
      • ApiRequest«Object»
      • ApiRequest«CardQueryDto»
      • ApiRequest«SubmitKycDto»
      • CreateCardDto
      • GetTokenDto
      • CardBenefitVo
      • ApiResponse«List«CardSampleInfoVo»»
      • CreateCardVo
      • ApiResponse«CreateCardVo»
      • CardQueryVo
      • ApiResponse«List«CardQueryVo»»
      • CardQueryDto
      • CardRechargeVo
      • ApiResponse«CardRechargeVo»
      • CardRechargeDto
      • RechargeOrderQueryVo
      • ApiResponse«RechargeOrderQueryVo»
      • RechargeOrderQueryDto
      • CardDetailVo
      • ApiResponse«CardDetailVo»
      • CardDetailDto
      • ApiResponse«Boolean»
      • CardStatusUpdateDto
      • ApiResponse«String»
      • CardPanHtmlDto
      • ApiEncryptVo
      • ApiResponse«ApiEncryptVo»
      • CardPanEncryptDto
      • CardQueryPinDto
      • CardPhoneDto
      • CardEmailDto
      • CardTradeLimitDto
      • BindCardVo
      • ApiResponse«BindCardVo»
      • BindCardDto
      • ActiveCardDto
      • CustomerAddVo
      • ApiResponse«CustomerAddVo»
      • CustomerAddDto
      • CustomerQueryVo
      • ApiResponse«CustomerQueryVo»
      • CustomerQueryDto
      • LivenessUrlQueryDto
      • ApiResponse«LivenessUrlQueryDto»
      • GetLivenessUrlDto
      • LivenessResultQueryDto
      • ApiResponse«LivenessResultQueryDto»
      • GetLivenessResultDto
      • SubmitKycDto
      • InHouseKycInfoVo
      • ApiResponse«InHouseKycInfoVo»
      • KycDto
      • Confirm3DSDto
  1. 01 Preparations

1.2 Appendix

Response code#

codedescription
200success
-1failed
1000000Incorrect parameters
1000001The ID card photo is abnormal
2000001The token has expired
2000002Token error
2000003Signature error
2000004The merchant doesn't exist
2000005The merchant has been disabled
2000006Api key or secret key error
2000007Invalid IP address
3000000Server internal error
3000001Third party error
4000000Business Anomaly
4000001Customer not found for this business
4000002This customer has completed KYC verification
4000003The customer has not submitted KYC verification
4000004Customer code already exists
4000005Customer biometric verification in progress
4000006The customer has completed live verification
4000007Unknown biometric authentication records
4010001The card sample does not exist or is not authorized
4010002The card sample has been disabled
4010003The sku or activation code is incorrect
4010004The physical card has been bound
4010005The physical card has not been bound. Please bind it first
4010006The card was not found
4010007card status is not binding, cannot be activated
4010008This card does not support resubmission
4020001The fee order cannot be found

Event Type#

eventTypeeventNamedescription
KYCkyc_statusKYC result callback
_3DS3dsAuthorization for 3DS Notification
TRADEtradeThis callback is a transaction notification, and it includes types such as authorization, settlement, cancellation, refund, transaction, and additional authorization notification.
Modified at 2026-02-12 03:23:04
Previous
1.1 Protocol Specification
Next
1.3 Login authorization
Built with