1.Submit KYC information（Deprecated）

• ApiCode: setUcardKyc
• Request Parameter

No	Field	Type	Required	Notes
1	email	String	Y	user email
2	mobileNumber	String	Y	user phone number
3	mobilePrefix	String	Y	mobile international dialing code(China 86, Korea 82, Japan 81 etc. )
4	mobilePrefixCountry	String	Y	user phone country code. ISO3166-2 2-digit country code. Example:MY
5	firstName	String	Y	Content must be in English. Example: Trump
6	lastName	String	Y	Content must be in English. Example: Donald
7	dateOfBirth	String	Y	date Of Birth: yyyy-MM-dd
8	addressLine	String	Y	Customer's residential address. Content must be in English. Maximum length: 140 characters.
9	city	String	Y	Customer's city of residence, Example:Paris
10	countryCode	String	Y	Customer's country of residence. ISO3166-2 2-digit country code. Example:MY
11	postCode	String	Y	Example: C2A2EX
12	state	String	Y	State
13	identificationType	String	Y	Allowed values: PASSPORT ID_CARD
14	identificationNumber	String	Y	identification Number
15	identificationExpiryDate	String	Y	identification Expiry Date:yyyy-MM-dd
16	frontImgBase64	String	Y	base64 encoding of the front of the document
17	backImgBase64	String	C	base64 encoding of the back of the document
18	handheldImgBase64	String	Y	base64 encoding of handheld documents

• Request Message

Request Body Example:

Request Body Example

{
    "email": "kyc@kazepay.io",
    "mobileNumber": "15659874544",
    "mobilePrefix": "60",
    "mobilePrefixCountry": "MY",
    "firstName": "Trump",
    "lastName": "Donald",
    "dateOfBirth": "1958-04-25",
    "addressLine": "Nashville TN 37011",
    "city": "Paris",
    "countryCode": "FR",
    "postCode": "223456",
    "state": "dizhi",
    "identificationType": "PASSPORT",
    "identificationNumber": "A563F186",
    "identificationExpiryDate": "2099-12-31",
    "frontImgBase64": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAA...",
    "handheldImgBase64": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQCC..."
}

Request Message Example:

Request Message Example

 { 
 "head": { 
 "apiCode": "setUcardKyc", 
 "sysId": "202402271432298822660001", 
 "requestNo": "2024062810200868740754", 
 "version": "1.0", 
 "sign": "29589585d30e6bfca3e2588f61d67cf7ff0567f4c5ccc79ef954da66326be51***", 
 "keyEnc": "7c819f5751420b267a32c6b1bb95735a327dcb20ca1c2abcafaa5125604a8***" 
 }, 
 "body":{ 
 "encrypt":"zcNZ5RFgBASAcOX5sRYiMSTaYN/3iNv3HA3/FXJmVkCnzkECPIpaw7daqowwv*******" 
 } 
 }

• Response Parameters

No	Field	Type	Required	Notes
1	encrypt	String	Y	Return values: SUCCESS FAILED
2	status	String	Y	Return values: WAITING_KYC REJECTED PASSED

• Response Message

Response Body Example:

Response Body Example

 { 
  "encrypt":"SUCCESS", 
  "status":"WAITING_KYC"
 } 

Response Message Example:

Response Message Example

 { 
 "head": { 
 "apiCode": "setUcardKyc", 
 "sysId": "202402271432298822660001",
 "requestNo": "2024062810200869481548", 
 "version": "1.0", 
 "code": "SUCCESS", 
 "detail": "SUCCESS", 
 "sign": "50a7aca6d7a65f848535aaf6cbfa674583e103afea9db4863b6b47953670cf8***", 
 "keyEnc": "b25973f85c9ff6092b6647a6ed5603384e14a853c3a06b6cfde5ae55eb165***" 
 }, 
 "body":{ 
 "encrypt":"aB3OMZSBlWyaDsPMtU4w/4lI87EWiR1hPzEdBlp9WVvOTjeeX4ZxPy2o+9x1a***"
 } 
 }

2.Upload kyc pictures

• ApiCode: fileUpload
• **Content-Type: ** multipart/form-data
• Maximum file size: 10M
• Image Type: PNG, JPG, JPEG
• Request Parameter

No	Field	Type	Required	Notes
1	email	String	Y	user email
2	mobileNumber	String	Y	user phone number
3	mobilePrefix	String	Y	mobile international dialing code(China 86, Korea 82, Japan 81 etc. )

• Request Message

Request Body Example:

Request Body Example

{
    "email": "kyc@kazepay.io",
    "mobileNumber": "15659874544",
    "mobilePrefix": "60"
}

Request Message Example:

Java

        
        
        String data="{\"head\":{\"sysId\":\"H2400002001\",\"apiCode\":\"fileUpload\",\"keyEnc\":\"8fd64e747dfde437b0c91d788507b994fc4d98e9e76656f4ba752cc33b1c1317140a2c37cf61af0ca205c96509d61b7ddcd2108540a7733be6c7fc5324c974a49b5ad96fcce74c0249a5f0fac03217fa2abf69722d71b7302c9856236a1627550c5d7599826001f85ae0aeefa0821e01671aff4dfc3b60071e7a175e15a33f3ef2a477ed1410a08dee503649eb88aae5d1af00eef50035712fb421f84abc36b9f9a08559505d2a248893bc7e63600177a92f281388086a375a091699691d21791204fed8183c2528b6903b8ac662add99d2541db03f25debb851cf5e542dc0a9c8c18e93c1cccc8e7b7efe58222a75285fbc68110fafb05a9f0dba9c11860c3e\",\"sign\":\"829afefbdb21bd67c919723209cb158746e7062c7256721f34dc3380a8467abf9b63c8c96ec77931bde6a438f10095f83f424b63a33d8f2ece16ef34b3c66ca971a4daaddd720eeb09b2d2ba366bb74d2b7238f071dbb9932c9c934c067b3cab97f502b4c38be6e091dcb70bc62ba23dcfda54bf01e2013e99a98871a8b3b8c0bc39598ddf8ab5b268c03d15632078483a7fa824f279dfc71228707e652ac8824cab9eb71f43d5090bf377d2646eae192c8e11feecc4018ab5c2fa6bd34c23a892561297fc1588967d0639c1304e5338ce08cf38423e070e6d886ee24ec0d5c191a45e5db2bd91e5d40e9691c23a32bbe8563d9410ba6a98df5ea5a57befb618\",\"requestNo\":\"174574749857359840\",\"version\":\"1.0\"},\"body\":{\"encrypt\":\"r4oW1DCZZYNyTeWgsFheUoCVyNkZawpHI+HPm6l/moWOn9KpJ46XivK7tilcnxs7QOTX5BzRPxqI2fsPqZ8Ru9J+Smoje4Z7eCdcP+eR/tE=\"}}";
        JSONObject req = JSONObject.parseObject(data);
        
       
        FileSystemResource fileResource = new FileSystemResource("E:\\test\\1.jpg");
        MultiValueMap<String, Object> body = new LinkedMultiValueMap<>();
        body.add("file", fileResource);
        
        
        HttpHeaders jsonHeader = new HttpHeaders();
        jsonHeader.setContentType(MediaType.APPLICATION_JSON);
        body.add("request", new HttpEntity<>(req, jsonHeader));
        
        HttpHeaders headers = new HttpHeaders();
        headers.setContentType(MediaType.MULTIPART_FORM_DATA);
        
        
        RestTemplate restTemplate = new RestTemplate();
        ResponseEntity<String> response = restTemplate.exchange(
            url,
            HttpMethod.POST,
            new HttpEntity<>(body, headers),
            String.class
        );

Shell

curl.exe -X POST http://localhost:8890/meta/api/file/upload `
  -F "file=@E:\test\1.jpg;type=image/jpeg" `
  -F "request={
    \`"head\`": {
      \`"sysId\`": \`"H2400002001\`",
      \`"apiCode\`": \`"fileUpload\`",
      \`"keyEnc\`": \`"68f65254141ed43c3d6ae6e93a19d5d5d65279661ddae5c25e031da0e3c939f624bd5f54c385369de76a276f1399580fa076151a16b5c646aa516f0dc1deb19e8c7aeaaf2799419244a62fd411e2505159f2870e519b9d920b5bfbf98423cf7870043554aa03cf619f90ae67d295d8599e6ee6707ed01f37deedac236adae18273de65697117d993296ebc1079cc3e69e795689fa2407a91b9b8951250f099444b0a23a4e1a88cf9fa54d0e9b6edbd30a68f74f142550ad37e6e34f45668faab51d15e55afa917dd4e72c7d2c889f99a5ff342da411d7f63889ee63c4def0e02bf2ecc8d12a76f9464007b1ea3ab0df724f1896d6881c95b2547afce261fcf10\`",
      \`"sign\`": \`"39b43fe5217f75af6afcda42e3a4353251e6299bf76700cbbe319b36af5413bff514f4273b85e2faf3b84d728bc23eb61c8fc18a70bff81d9af4b08331fd547c62f1bbf24275b3e016976fb2acaf0b83efeebaca1c6826694f4afb08ca34b996c812e3adfe9dc85305393b776d75517a138876df201b88fe910b5d84bd0f9ad048b0214669e55814356b0c86630667b63d0087efee2eb22d55d69adf5d18d7ac84878d82fac191e37e35b570320fce05225bd41375769c6dc6d7ca30f8ac0bb775d31750c5dc43abb8e0c7ca18ca848c9ac44091fb42f1b21160046585d1ad1dbb61dffda599b389d139ffaeac5eea7fd9901166914e88df46a378e2f4b9bfec\`",
      \`"requestNo\`": \`"174557348960234502\`",
      \`"version\`": \`"1.0\`"
    },
    \`"body\`": {
      \`"encrypt\`": \`"8Ez3WyOb012zld8e8ICBiWCiA9OSE44gn7JAIBFtESCtlhVZvaXfACVPUi1wA6f8upHj73coISKJ1uf1s3URDGrfsjdn5XJTGrFEU2+RwoM=\`"
    }
  };type=application/json"

• Response Parameters

No	Field	Type	Required	Notes
1	encrypt	String	Y	Return values: SUCCESS FAILED
2	fileId	String	Y	File id

• Response Message

Response Body Example:

Response Body Example

 { 
  "encrypt":"SUCCESS", 
  "fileId":"004a0d62-c901-459d-b32b-1f992a451ba1"
 } 

Response Message Example:

Response Message Example

{
    "head": {
        "sysId": "H2400002001",
        "apiCode": "fileUpload",
        "requestNo": "174574749857359840",
        "version": "1.0",
        "code": "SUCCESS",
        "detail": "SUCCESS",
        "sign": "53df0c735deb74c9b6cc108ab0b1daad053aa26a90a1a26756ff44ed0eece9c72804035ed91edb0f6f51220a72738e79548c5ec566c89a52d15581495c2d0e32017ca94de48a71550fca2204608671c7e2a3bf27c61fe77831f87e236892520dcf2ad351711fd76fec0ba513ec256be6e64d37a1c61ef49a1e5f58547c1d3200b69d024edd746658c71706c491671b7a665f9b8dd234db2e461e974c6ded9644cb071b1528ce82d1933c7d45d32404d3f3e94399699cbff721b9aad7d618a657b5daeab69394b537ee38de6cb460be3d83eff07209f0448a340906bd551468fbb49def514041b07355b0a75f0d8dd1ea9aec749aa02e2b77800f329207496bc8",
        "keyEnc": "23a978a916dfeba1a08b0abe1939d61bf1607d4744c4e0d48ae98a7a83b26cbbaad693f07c1e88e694a63fd3dc06611a33af7cda2e20c3cdbe8a27d911a4c16e312bede36fc541151df4f0de4e56a6c17c4dfc9afac37959842084e43b7dbafdd6d7d61b776baf1901b6290975ac3825384c91e9c4b69381ee75d04d14bf771e0061a3a218c49c4e11a09f1f590a06eab993aa2d131a1e6caec5052d2a19fa1f96f0e8304cfb6dd7c07d5dd0d4dc0d543b81a868587cc58d4eae8cfbef2d8e01868a888e4dfc018ff61d3d990fa67063cca3851ed057f0572c714bf0ee62fc540407894a97f702bc9f78f528f30b956a82e4d2c2f56f37b1e371c182fd5108be"
    },
    "body": {
        "encrypt": "Ckp2toBWOcJGelmzpEMN1T+TAywGCbcbUUScrrCuTnMqQQd0DHHpFAmGFpbMJlzma0rQe3GnsiTu013dJ3WbZkKQlhLFQ71Zsw6dpX/u8RY="
    }
}

3.Submit KYC information（new）

• ApiCode: setUcardKycNew
• Request Parameter

No	Field	Type	Required	Notes
1	email	String	Y	user email
2	mobileNumber	String	Y	user phone number
3	mobilePrefix	String	Y	mobile international dialing code(China 86, Korea 82, Japan 81 etc. )
4	mobilePrefixCountry	String	Y	user phone country code. ISO3166-2 2-digit country code. Example:MY
5	firstName	String	Y	Content must be in English. Example: Trump
6	lastName	String	Y	Content must be in English. Example: Donald
7	dateOfBirth	String	Y	date Of Birth: yyyy-MM-dd
8	addressLine	String	Y	Customer's residential address. Content must be in English. Maximum length: 140 characters.
9	city	String	Y	Customer's city of residence, Example:Paris
10	countryCode	String	Y	Customer's country of residence. ISO3166-2 2-digit country code. Example:MY
11	postCode	String	Y	Example: C2A2EX
12	state	String	Y	State
13	identificationType	String	Y	Allowed values: PASSPORT ID_CARD
14	identificationNumber	String	Y	identification Number
15	identificationExpiryDate	String	Y	identification Expiry Date:yyyy-MM-dd
16	frontImgFileId	String	Y	Get the file id by uploading the file through ApiCode=fileUpload
17	backImgFileId	String	C	Required for ID_CARD,Get the file id by uploading the file through ApiCode=fileUpload
18	handheldImgFileId	String	Y	Get the file id by uploading the file through ApiCode=fileUpload

• Request Message

Request Body Example:

Request Body Example

{
    "email": "kyc@kazepay.io",
    "mobileNumber": "15659874544",
    "mobilePrefix": "60",
    "mobilePrefixCountry": "MY",
    "firstName": "Trump",
    "lastName": "Donald",
    "dateOfBirth": "1958-04-25",
    "addressLine": "Nashville TN 37011",
    "city": "Paris",
    "countryCode": "FR",
    "postCode": "223456",
    "state": "dizhi",
    "identificationType": "PASSPORT",
    "identificationNumber": "A563F186",
    "identificationExpiryDate": "2099-12-31",
    "frontImgFileId": "004a0d62-c901-459d-b32b-1f992a451ba1",
    "handheldImgFileId": "004a0d62-c901-459d-b32b-1f992a451ba1"
}

Request Message Example:

Request Message Example

 { 
 "head": { 
 "apiCode": "setUcardKyc", 
 "sysId": "202402271432298822660001", 
 "requestNo": "2024062810200868740754", 
 "version": "1.0", 
 "sign": "29589585d30e6bfca3e2588f61d67cf7ff0567f4c5ccc79ef954da66326be51***", 
 "keyEnc": "7c819f5751420b267a32c6b1bb95735a327dcb20ca1c2abcafaa5125604a8***" 
 }, 
 "body":{ 
 "encrypt":"zcNZ5RFgBASAcOX5sRYiMSTaYN/3iNv3HA3/FXJmVkCnzkECPIpaw7daqowwv*******" 
 } 
 }

• Response Parameters

No	Field	Type	Required	Notes
1	encrypt	String	Y	Return values: SUCCESS FAILED
2	status	String	Y	Return values: WAITING_KYC REJECTED PASSED

• Response Message

Response Body Example:

Response Body Example

 { 
  "encrypt":"SUCCESS", 
  "status":"WAITING_KYC"
 } 

Response Message Example:

Response Message Example

 { 
 "head": { 
 "apiCode": "setUcardKyc", 
 "sysId": "202402271432298822660001",
 "requestNo": "2024062810200869481548", 
 "version": "1.0", 
 "code": "SUCCESS", 
 "detail": "SUCCESS", 
 "sign": "50a7aca6d7a65f848535aaf6cbfa674583e103afea9db4863b6b47953670cf8***", 
 "keyEnc": "b25973f85c9ff6092b6647a6ed5603384e14a853c3a06b6cfde5ae55eb165***" 
 }, 
 "body":{ 
 "encrypt":"aB3OMZSBlWyaDsPMtU4w/4lI87EWiR1hPzEdBlp9WVvOTjeeX4ZxPy2o+9x1a***"
 } 
 }

4.Submit KYC information（Link Verification）

• ApiCode: setUserKyc
• Request Parameter

No	Field	Type	Required	Notes
1	email	String	Y	user email
2	mobileNumber	String	Y	user phone number
3	mobilePrefix	String	Y	mobile international dialing code(China 86, Korea 82, Japan 81 etc. )
4	mobilePrefixCountry	String	Y	user phone country code. ISO3166-2 2-digit country code. Example:MY
5	firstName	String	Y	Content must be in English. Example: Trump
6	lastName	String	Y	Content must be in English. Example: Donald
7	dateOfBirth	String	Y	date Of Birth: yyyy-MM-dd
8	addressLine	String	Y	Customer's residential address. Content must be in English. Maximum length: 140 characters.
9	city	String	Y	Customer's city of residence, Example:Paris
10	countryCode	String	Y	Customer's country of residence. ISO3166-2 2-digit country code. Example:MY
11	postCode	String	Y	Example: C2A2EX
12	state	String	Y	State
13	identificationType	String	Y	Allowed values: PASSPORT ID_CARD
14	identificationNumber	String	Y	identification Number
15	identificationExpiryDate	String	Y	identification Expiry Date:yyyy-MM-dd

• Request Message

Request Body Example:

Request Body Example

{
    "email": "kyc@kazepay.io",
    "mobileNumber": "15659874544",
    "mobilePrefix": "60",
    "mobilePrefixCountry": "MY",
    "firstName": "Trump",
    "lastName": "Donald",
    "dateOfBirth": "1958-04-25",
    "addressLine": "Nashville TN 37011",
    "city": "Paris",
    "countryCode": "FR",
    "postCode": "223456",
    "state": "dizhi",
    "identificationType": "PASSPORT",
    "identificationNumber": "A563F186",
    "identificationExpiryDate": "2099-12-31"
}

Request Message Example:

Request Message Example

 { 
 "head": { 
 "apiCode": "setUserKyc", 
 "sysId": "202402271432298822660001", 
 "requestNo": "2024062810200868740754", 
 "version": "1.0", 
 "sign": "29589585d30e6bfca3e2588f61d67cf7ff0567f4c5ccc79ef954da66326be51***", 
 "keyEnc": "7c819f5751420b267a32c6b1bb95735a327dcb20ca1c2abcafaa5125604a8***" 
 }, 
 "body":{ 
 "encrypt":"zcNZ5RFgBASAcOX5sRYiMSTaYN/3iNv3HA3/FXJmVkCnzkECPIpaw7daqowwv*******" 
 } 
 }

• Response Parameters

No	Field	Type	Required	Notes
1	encrypt	String	Y	Return values: SUCCESS FAILED
2	kycUrl	String	Y	KYC verification address

• Response Message

Response Body Example:

Response Body Example

 { 
  "encrypt":"SUCCESS", 
  "kycUrl":"https://"
 } 

Response Message Example:

Response Message Example

 { 
 "head": { 
 "apiCode": "setUserKyc", 
 "sysId": "202402271432298822660001",
 "requestNo": "2024062810200869481548", 
 "version": "1.0", 
 "code": "SUCCESS", 
 "detail": "SUCCESS", 
 "sign": "50a7aca6d7a65f848535aaf6cbfa674583e103afea9db4863b6b47953670cf8***", 
 "keyEnc": "b25973f85c9ff6092b6647a6ed5603384e14a853c3a06b6cfde5ae55eb165***" 
 }, 
 "body":{ 
 "encrypt":"aB3OMZSBlWyaDsPMtU4w/4lI87EWiR1hPzEdBlp9WVvOTjeeX4ZxPy2o+9x1a***"
 } 
 }

5.Query KYC Status

• ApiCode: queryUcardKycStatus
• Request Parameter

No	Field	Type	Required	Notes
1	email	String	Y	user email

• Request Message

Request Body Example:

Request Body Example

 { 
 "email":"kyc@kazepay.io"
 } 

Request Message Example:

Request Message Example

 { 
 "head": { 
 "apiCode": "queryUcardKycStatus", 
 "sysId": "202402271432298822660001", 
 "requestNo": "202406286784453105011", 
 "version": "1.0", 
 "sign": "29589585d30e6bfca3e2588f61d67cf7ff0567f4c5ccc79ef954da66326be51***", 
 "keyEnc": "7c819f5751420b267a32c6b1bb95735a327dcb20ca1c2abcafaa5125604a8***" 
 }, 
 "body":{ 
 "encrypt":"zcNZ5RFgBASAcOX5sRYiMSTaYN/3iNv3HA3/FXJmVkCnzkECPIpaw7daqowwv*******" 
 } 
 }

• Response Parameters

No	Field	Type	Required	Notes
1	encrypt	String	Y	Return values: SUCCESS FAILED
2	status	String	Y	KYC status

• Response Message

Response Body Example:

Response Body Example

 { 
  "encrypt":"SUCCESS", 
  "status":"PASSED"
 } 

Response Message Example:

Response Message Example

 { 
 "head": { 
 "apiCode": "queryUcardKycStatus", 
 "sysId": "202402271432298822660001",
 "requestNo": "202406291057782573625", 
 "version": "1.0", 
 "code": "SUCCESS", 
 "detail": "SUCCESS", 
 "sign": "50a7aca6d7a65f848535aaf6cbfa674583e103afea9db4863b6b47953670cf8***", 
 "keyEnc": "b25973f85c9ff6092b6647a6ed5603384e14a853c3a06b6cfde5ae55eb165***" 
 }, 
 "body":{ 
 "encrypt":"aB3OMZSBlWyaDsPMtU4w/4lI87EWiR1hPzEdBlp9WVvOTjeeX4ZxPy2o+9x1a***"
 } 
 }

6.Card Assign

• ApiCode: ucardAssign
• Request Parameter

No	Field	Type	Required	Notes
1	email	String	Y	user email
2	cardNumber	String	Y	Card number
3	autoActive	boolean	Y	Allowed values: true false. If true, no need to send the request with ApiCode=ucardActive

• Request Message

Request Body Example:

Request Body Example

 { 
   "email":"kyc@kazepay.io",
   "cardNumber":"4937240800070604",
   "autoActive":true
 } 

Request Message Example:

Request Message Example

 { 
 "head": { 
 "apiCode": "ucardAssign", 
 "sysId": "202402271432298822660001", 
 "requestNo": "202406286784453105011", 
 "version": "1.0", 
 "sign": "29589585d30e6bfca3e2588f61d67cf7ff0567f4c5ccc79ef954da66326be51***", 
 "keyEnc": "7c819f5751420b267a32c6b1bb95735a327dcb20ca1c2abcafaa5125604a8***" 
 }, 
 "body":{ 
 "encrypt":"zcNZ5RFgBASAcOX5sRYiMSTaYN/3iNv3HA3/FXJmVkCnzkECPIpaw7daqowwv*******" 
 } 
 }

• Response Parameters

No	Field	Type	Required	Notes
1	encrypt	String	Y	Return values: SUCCESS FAILED
2	cardID	String	Y	Card ID

• Response Message

Response Body Example:

Response Body Example

 { 
  "encrypt":"SUCCESS", 
  "cardID":"3377"
 } 

Response Message Example:

Response Message Example

 { 
 "head": { 
 "apiCode": "ucardAssign", 
 "sysId": "202402271432298822660001",
 "requestNo": "202406291057782573625", 
 "version": "1.0", 
 "code": "SUCCESS", 
 "detail": "SUCCESS", 
 "sign": "50a7aca6d7a65f848535aaf6cbfa674583e103afea9db4863b6b47953670cf8***", 
 "keyEnc": "b25973f85c9ff6092b6647a6ed5603384e14a853c3a06b6cfde5ae55eb165***" 
 }, 
 "body":{ 
 "encrypt":"aB3OMZSBlWyaDsPMtU4w/4lI87EWiR1hPzEdBlp9WVvOTjeeX4ZxPy2o+9x1a***"
 } 
 }

7.Activate Physical Cards

The card can only be activated after KYC review is passed.

• ApiCode: ucardActive
• Request Parameter

No	Field	Type	Required	Notes
1	cardID	String	Y	Card ID
2	activationCode	String	Y	activation code, obtained by receiving messages through the kazepay system, can only be obtained once

• Request Message

Request Body Example:

Request Body Example

 { 
   "cardID":"3377",
   "activationCode":"70795665"
 } 

Request Message Example:

Request Message Example

 { 
 "head": { 
 "apiCode": "ucardActive", 
 "sysId": "202402271432298822660001", 
 "requestNo": "2024070125200867330488", 
 "version": "1.0", 
 "sign": "29589585d30e6bfca3e2588f61d67cf7ff0567f4c5ccc79ef954da66326be51***", 
 "keyEnc": "7c819f5751420b267a32c6b1bb95735a327dcb20ca1c2abcafaa5125604a8***" 
 }, 
 "body":{ 
 "encrypt":"zcNZ5RFgBASAcOX5sRYiMSTaYN/3iNv3HA3/FXJmVkCnzkECPIpaw7daqowwv*******" 
 } 
 }

• Response Parameters

No	Field	Type	Required	Notes
1	encrypt	String	Y	Return values: SUCCESS FAILED
2	cardID	String	Y	Card ID
3	status	String	Y	Card Status, Refer to Appendix Part 2

• Response Message

Response Body Example:

Response Body Example

 { 
   "encrypt":"SUCCESS",
   "cardID":"3295",
   "status":"ACTIVE_PROCESSING"
 } 

Response Message Example:

Response Message Example

{ 
 "head": { 
 "apiCode": "ucardActive", 
 "sysId": "202402271432298822660001",
 "requestNo": "2024070125209774330022", 
 "version": "1.0", 
 "code": "SUCCESS", 
 "detail": "SUCCESS", 
 "sign": "50a7aca6d7a65f848535aaf6cbfa674583e103afea9db4863b6b47953670cf8***", 
 "keyEnc": "b25973f85c9ff6092b6647a6ed5603384e14a853c3a06b6cfde5ae55eb165***" 
 }, 
 "body":{ 
 "encrypt":"aB3OMZSBlWyaDsPMtU4w/4lI87EWiR1hPzEdBlp9WVvOTjeeX4ZxPy2o+9x1a***"
 } 
 }

8.Set Card Pin

• ApiCode: cardSetPin
• Request Parameter

No	Field	Type	Required	Notes
1	cardID	String	Y	Card ID
2	pin	String	Y	must be a six-digit number

• Request Message

Request Body Example:

Request Body Example

 { 
   "cardID":"3295",
   "pin":"375426"
 } 

Request Message Example:

Request Message Example

 { 
 "head": { 
 "apiCode": "cardSetPin", 
 "sysId": "202402271432298822660001", 
 "requestNo": "2024072322453354794101", 
 "version": "1.0", 
 "sign": "29589585d30e6bfca3e2588f61d67cf7ff0567f4c5ccc79ef954da66326be51***", 
 "keyEnc": "7c819f5751420b267a32c6b1bb95735a327dcb20ca1c2abcafaa5125604a8***" 
 }, 
 "body":{ 
 "encrypt":"zcNZ5RFgBASAcOX5sRYiMSTaYN/3iNv3HA3/FXJmVkCnzkECPIpaw7daqowwv*******" 
 } 
 }

• Response Parameters

No	Field	Type	Required	Notes
1	encrypt	String	Y	Return values: SUCCESS FAILED

• Response Message

Response Body Example:

Response Body Example

 { 
   "encrypt":"SUCCESS"
 } 

Response Message Example:

Response Message Example

 { 
 "head": { 
 "apiCode": "cardSetPin", 
 "sysId": "202402271432298822660001",
 "requestNo": "2024072357452354792298", 
 "version": "1.0", 
 "code": "SUCCESS", 
 "detail": "SUCCESS", 
 "sign": "50a7aca6d7a65f848535aaf6cbfa674583e103afea9db4863b6b47953670cf8***", 
 "keyEnc": "b25973f85c9ff6092b6647a6ed5603384e14a853c3a06b6cfde5ae55eb165***" 
 }, 
 "body":{ 
 "encrypt":"aB3OMZSBlWyaDsPMtU4w/4lI87EWiR1hPzEdBlp9WVvOTjeeX4ZxPy2o+9x1a***"
 } 
 }

9.Query Card Information

• ApiCode: queryCard
• Request Parameter

No	Field	Type	Required	Notes
1	cardID	String	Y	Card ID

• Request Message

Request Body Example:

Request Body Example

 { 
 "cardID":"19181"
 } 

Request Message Example:

Request Message Example

 { 
 "head": { 
 "apiCode": "queryCard", 
 "sysId": "202402271432298822660001", 
 "requestNo": "2024022810200867360001", 
 "version": "1.0", 
 "sign": "29589585d30e6bfca3e2588f61d67cf7ff0567f4c5ccc79ef954da66326be51***", 
 "keyEnc": "7c819f5751420b267a32c6b1bb95735a327dcb20ca1c2abcafaa5125604a8***" 
 }, 
 "body":{ 
 "encrypt":"zcNZ5RFgBASAcOX5sRYiMSTaYN/3iNv3HA3/FXJmVkCnzkECPIpaw7daqowwv*******" 
 } 
 }

• Response Parameters

No	Field	Type	Required	Notes
1	cardID	String	Y	Card ID
2	cardNo	String	Y	Bankcard Number
3	cardCvv	String	Y	Bankcard Cvv code, Only Virtual Card return this Field
4	expiryDate	String	Y	Bankcard Expiry Date(YYMM)
5	currency	String	Y	Bankcard currency
6	userBankCardStatus	String	Y	Bankcard status
7	cardHolderEmail	String	C	user email, should not be used
8	cardHolderMobileNumber	String	C	user phone number,should not be used
9	cardHolderMobilePrefix	String	C	user phone country code(China 86, Korea 82, Japan 81 etc. )
10	countryCode	String	C	Billing Country
11	billingState	String	C	Billing State
12	billingCity	String	C	Billing City
13	billingAddress	String	C	Billing Address
14	billingZipCode	String	C	Postal Code

• Response Message

Response Body Example:

Response Body Example

 { 
 "cardID":"19181",
 "cardNo":"2229298088662389",
 "cardCvv":"195",
 "expiryDate":"2707",
 "currency":"USD",
 "userBankCardStatus":"ACTIVE",
 "cardHolderEmail":"kazepay@kazepay.io",
 "cardHolderMobileNumber":"108248888",
 "cardHolderMobilePrefix":"60",
 "countryCode":"HONG KONG",
 "billingState":"HONG KONG",
 "billingCity":"HONG KONG",
 "billingAddress":"17/F FWD FINANCIAL CTR 308 DES VOEUX RD CENTRAL HK",
 "billingZipCode":"000000"
 } 

Response Message Example:

Response Message Example

 { 
 "head": { 
 "apiCode": "queryCard", 
 "sysId": "202402271432298822660001",
 "requestNo": "202404241536050972805001", 
 "version": "1.0", 
 "code": "SUCCESS", 
 "detail": "SUCCESS", 
 "sign": "50a7aca6d7a65f848535aaf6cbfa674583e103afea9db4863b6b47953670cf8***", 
 "keyEnc": "b25973f85c9ff6092b6647a6ed5603384e14a853c3a06b6cfde5ae55eb165***" 
 }, 
 "body":{ 
 "encrypt":"aB3OMZSBlWyaDsPMtU4w/4lI87EWiR1hPzEdBlp9WVvOTjeeX4ZxPy2o+9x1a***"
 } 
 }

10.Query Card Balance

• ApiCode: cardBalance
• Request Parameter

No	Field	Type	Required	Notes
1	cardID	String	Y	Card ID
2	currency	String	Y	Currency (default USD)

• Request Message

Request Body Example:

Request Body Example

 { 
 "cardID":"19181",
 "currency":"USD"
 } 

Request Message Example:

Request Message Example

{ 
 "head": { 
 "apiCode": "cardBalance", 
 "sysId": "202402271432298822660001", 
 "requestNo": "202404220205221238690954", 
 "version": "1.0", 
 "sign": "29589585d30e6bfca3e2588f61d67cf7ff0567f4c5ccc79ef954da66326be51***", 
 "keyEnc": "7c819f5751420b267a32c6b1bb95735a327dcb20ca1c2abcafaa5125604a8***" 
 }, 
 "body":{ 
 "encrypt":"zcNZ5RFgBASAcOX5sRYiMSTaYN/3iNv3HA3/FXJmVkCnzkECPIpaw7daqowwv*******" 
 } 
 }

• Response Parameters

No	Field	Type	Required	Notes
1	cardID	String	Y	Card ID
2	currency	String	Y	Currency (default USD)
3	avaBalance	Double	Y	Card available balance
4	blockBalance	Double	Y	Card freeze balance

• Response Message

Response Body Example:

Response Body Example

 { 
 "cardID":"19181",
 "currency":"USD",
 "avaBalance":18506.25,
 "blockBalance":2020.00
 } 

Response Message Example:

Response Message Example

{ 
 "head": { 
 "apiCode": "cardBalance", 
 "sysId": "202402271432298822660001",
 "requestNo": "202404220205221238690954", 
 "version": "1.0", 
 "code": "SUCCESS", 
 "detail": "SUCCESS", 
 "sign": "50a7aca6d7a65f848535aaf6cbfa674583e103afea9db4863b6b47953670cf8***", 
 "keyEnc": "b25973f85c9ff6092b6647a6ed5603384e14a853c3a06b6cfde5ae55eb165***" 
 }, 
 "body":{ 
 "encrypt":"aB3OMZSBlWyaDsPMtU4w/4lI87EWiR1hPzEdBlp9WVvOTjeeX4ZxPy2o+9x1a***"
 } 
 }

11.Recharge Card

• ApiCode: cardRecharge
• Request Parameter

No	Field	Type	Required	Notes
1	cardID	String	Y	Card ID
2	currency	String	Y	Currency (default USD)
3	amount	Double	Y	Top up amount

• Request Message

Request Body Example:

Request Body Example

 { 
 "cardID":"19181",
 "currency":"USD",
 "amount":5000.00
 } 

Request Message Example:

Request Message Example

 { 
 "head": { 
 "apiCode": "cardRecharge", 
 "sysId": "202402271432298822660001", 
 "requestNo": "202404240210584029864396", 
 "version": "1.0", 
 "sign": "29589585d30e6bfca3e2588f61d67cf7ff0567f4c5ccc79ef954da66326be51***", 
 "keyEnc": "7c819f5751420b267a32c6b1bb95735a327dcb20ca1c2abcafaa5125604a8***" 
 }, 
 "body":{ 
 "encrypt":"zcNZ5RFgBASAcOX5sRYiMSTaYN/3iNv3HA3/FXJmVkCnzkECPIpaw7daqowwv*******" 
 } 
 }

• Response Parameters

No	Field	Type	Required	Notes
1	cardID	String	Y	Card ID
2	currency	String	Y	Currency (default USD)
3	transactionId	String	Y	Request unique transaction id
4	transactionStatus	String	Y	Refer to Appendix Part 3
5	sendAmount	Double	Y	Top up amount

• Response Message

Response Body Example:

Response Body Example

 { 
 "cardID":"19181",
 "currency":"USD",
 "transactionId":"LM2312151602393234580",
 "transactionStatus":"PENDING",
 "sendAmount":"5000.00"
 } 

Response Message Example:

Response Message Example

{ 
 "head": { 
 "apiCode": "cardRecharge", 
 "sysId": "202402271432298822660001",
 "requestNo": "202404240210584029864396", 
 "version": "1.0", 
 "code": "SUCCESS", 
 "detail": "SUCCESS", 
 "sign": "50a7aca6d7a65f848535aaf6cbfa674583e103afea9db4863b6b47953670cf8***", 
 "keyEnc": "b25973f85c9ff6092b6647a6ed5603384e14a853c3a06b6cfde5ae55eb165***" 
 }, 
 "body":{ 
 "encrypt":"aB3OMZSBlWyaDsPMtU4w/4lI87EWiR1hPzEdBlp9WVvOTjeeX4ZxPy2o+9x1a***"
 } 
 }

12.Query Card Transactions

• ApiCode: queryTransactions
• Request Parameter

No	Field	Type	Required	Notes
1	cardID	String	Y	Card ID
2	transactionId	String	N	Transaction ID
3	pageSize	Number	N	The value range is [1,100], and the default value is 10
4	pageNum	Number	N	The value range is [1,10], and the default value is 1
5	transactionStartTime	String	N	from time(yyyy-MM-dd HH:mm:ss)
6	transactionEndTime	String	N	end time(yyyy-MM-dd HH:mm:ss)

• Request Message

Request Body Example:

Request Body Example

 { 
 "cardID":"19181",
 "transactionId":"LM2312151602393234580"
 } 

Request Message Example:

Request Message Example

 { 
 "head": { 
 "apiCode": "queryTransactions", 
 "sysId": "202407271432298822660001", 
 "requestNo": "2024022810200867360001", 
 "version": "1.0", 
 "sign": "29589585d30e6bfca3e2588f61d67cf7ff0567f4c5ccc79ef954da66326be51***", 
 "keyEnc": "7c819f5751420b267a32c6b1bb95735a327dcb20ca1c2abcafaa5125604a8***" 
 }, 
 "body":{ 
 "encrypt":"zcNZ5RFgBASAcOX5sRYiMSTaYN/3iNv3HA3/FXJmVkCnzkECPIpaw7daqowwv*******" 
 } 
 }

• Response Parameters

No	Field	Type	Required	Notes
1	cardID	String	Y	Card ID
2	transactionId	String	Y	Transaction ID
3	transactionTime	String	Y	yyyy-MM-dd HH:mm:ss
4	cardCurrency	String	Y	Card currency type
5	cardCurrencyAmt	Double	Y	Card currency trans Amount
6	transCurrency	String	Y	Transaction currency type
7	transCurrencyAmt	Double	Y	Transaction currency trans Amount
8	feeCurrency	String	Y	Currency of the transaction fee
9	fee	Double	Y	Transaction fee
10	transStatus	String	Y	Transaction status
11	transType	String	Y	Transaction type
12	merchantName	String	Y	Merchant name
13	respCode	String	Y	Response Code
14	respCodeDesc	String	Y	Response code Description

• Response Message

Response Body Example:

Response Body Example

  [{
      "cardID": "19181",
      "transactionId": "57724528-78b6-4ae2-919f-1efff348f460",
      "transactionTime": "2024-02-08 13:17:02",
      "cardCurrency": "USD",
      "cardCurrencyAmt": -13.09,
      "transCurrency": "EUR",
      "transCurrencyAmt": -11.90,
      "feeCurrency": "USD",
      "fee": -0.250000,
      "transStatus": "Pending",
      "transType": "Expenditure",
      "merchantName": "MEITUAN FOOD           BEIJING       CHN",
      "respCode":"000000",
      "respCodeDesc":"SUCCESS"
  },
      ...
  ]

Response Message Example:

Response Message Example

 { 
 "head": { 
 "apiCode": "queryTransactions", 
 "sysId": "202402271432298822660001",
 "requestNo": "202404241536050972805001", 
 "version": "1.0", 
 "code": "SUCCESS", 
 "detail": "SUCCESS", 
 "sign": "50a7aca6d7a65f848535aaf6cbfa674583e103afea9db4863b6b47953670cf8***", 
 "keyEnc": "b25973f85c9ff6092b6647a6ed5603384e14a853c3a06b6cfde5ae55eb165***" 
 }, 
 "body":{ 
 "encrypt":"aB3OMZSBlWyaDsPMtU4w/4lI87EWiR1hPzEdBlp9WVvOTjeeX4ZxPy2o+9x1a***"
 } 
 }

13.Set Card Status

• ApiCode: updCardStatus
• Request Parameter

No	Field	Type	Required	Notes
1	cardID	String	Y	Card ID
2	status	String	Y	Allowed values: ACTIVE INACTIVE

• Request Message

Request Body Example:

Request Body Example

 { 
 "cardID":"19181",
 "status":"INACTIVE"
 } 

Request Message Example:

Request Message Example

{ 
 "head": { 
 "apiCode": "updCardStatus", 
 "sysId": "202402271432298822660001", 
 "requestNo": "202407220205543213878644", 
 "version": "1.0", 
 "sign": "29589585d30e6bfca3e2588f61d67cf7ff0567f4c5ccc79ef954da66326be51***", 
 "keyEnc": "7c819f5751420b267a32c6b1bb95735a327dcb20ca1c2abcafaa5125604a8***" 
 }, 
 "body":{ 
 "encrypt":"zcNZ5RFgBASAcOX5sRYiMSTaYN/3iNv3HA3/FXJmVkCnzkECPIpaw7daqowwv*******" 
 } 
 }

• Response Parameters

No	Field	Type	Required	Notes
1	cardID	String	Y	Card ID
2	status	String	Y	Card Status

• Response Message

Response Body Example:

Response Body Example

 { 
 "cardID":"19181",
 "status":"INACTIVE"
 } 

Response Message Example:

Response Message Example

{ 
 "head": { 
 "apiCode": "cardBalance", 
 "sysId": "202402271432298822660001",
 "requestNo": "202407220215356714587788", 
 "version": "1.0", 
 "code": "SUCCESS", 
 "detail": "SUCCESS", 
 "sign": "50a7aca6d7a65f848535aaf6cbfa674583e103afea9db4863b6b47953670cf8***", 
 "keyEnc": "b25973f85c9ff6092b6647a6ed5603384e14a853c3a06b6cfde5ae55eb165***" 
 }, 
 "body":{ 
 "encrypt":"aB3OMZSBlWyaDsPMtU4w/4lI87EWiR1hPzEdBlp9WVvOTjeeX4ZxPy2o+9x1a***"
 } 
 }

14.Close Card

Close the Bankcard ,the funds will be returned to the merchant's account.

• ApiCode: closeCard
• Request Parameter

No	Field	Type	Required	Notes
1	cardID	String	Y	Card ID

• Request Message

Request Body Example:

Request Body Example

 { 
 "cardID":"19181"
 } 

Request Message Example:

Request Message Example

{ 
 "head": { 
 "apiCode": "closeCard", 
 "sysId": "202402271432298822660001", 
 "requestNo": "202407220611314533251902", 
 "version": "1.0", 
 "sign": "29589585d30e6bfca3e2588f61d67cf7ff0567f4c5ccc79ef954da66326be51***", 
 "keyEnc": "7c819f5751420b267a32c6b1bb95735a327dcb20ca1c2abcafaa5125604a8***" 
 }, 
 "body":{ 
 "encrypt":"zcNZ5RFgBASAcOX5sRYiMSTaYN/3iNv3HA3/FXJmVkCnzkECPIpaw7daqowwv*******" 
 } 
 }

• Response Parameters

No	Field	Type	Required	Notes
1	cardID	String	Y	Card ID
2	status	String	Y	Card Status
3	refundAmt	String	Y	Refund amount
4	currency	String	Y	Currency (default USD)
5	txnId	String	Y	Transaction ID

• Response Message

Response Body Example:

Response Body Example

 { 
 "cardID":"19181",
 "status":"CLOSE_PROCESSING",
 "refundAmt":"65.22",
 "currency":"USD",
 "txnId":"2412111444075320115"
 } 

Response Message Example:

Response Message Example

{ 
 "head": { 
 "apiCode": "cardBalance", 
 "sysId": "202402271432298822660001",
 "requestNo": "202407220623012824582948", 
 "version": "1.0", 
 "code": "SUCCESS", 
 "detail": "SUCCESS", 
 "sign": "50a7aca6d7a65f848535aaf6cbfa674583e103afea9db4863b6b47953670cf8***", 
 "keyEnc": "b25973f85c9ff6092b6647a6ed5603384e14a853c3a06b6cfde5ae55eb165***" 
 }, 
 "body":{ 
 "encrypt":"aB3OMZSBlWyaDsPMtU4w/4lI87EWiR1hPzEdBlp9WVvOTjeeX4ZxPy2o+9x1a***"
 } 
 }

15.Get Card ID

• ApiCode: getCardId
• Request Parameter

No	Field	Type	Required	Notes
1	cardNo	String	Y	cardNo

• Request Message

Request Body Example:

Request Body Example

 { 
 "cardNo":"123456123456"
 } 

Request Message Example:

Request Message Example

{ 
 "head": { 
 "apiCode": "getCardId", 
 "sysId": "202402271432298822660001", 
 "requestNo": "202407220205543213878644", 
 "version": "1.0", 
 "sign": "29589585d30e6bfca3e2588f61d67cf7ff0567f4c5ccc79ef954da66326be51***", 
 "keyEnc": "7c819f5751420b267a32c6b1bb95735a327dcb20ca1c2abcafaa5125604a8***" 
 }, 
 "body":{ 
 "encrypt":"zcNZ5RFgBASAcOX5sRYiMSTaYN/3iNv3HA3/FXJmVkCnzkECPIpaw7daqowwv*******" 
 } 
 }

• Response Parameters

No	Field	Type	Required	Notes
1	cardID	String	Y	Card ID
2	cardNo	String	Y	cardNo

• Response Message

Response Body Example:

Response Body Example

 { 
 "cardID":"19181",
 "cardNo":"123456123456"
 } 

Response Message Example:

Response Message Example

{ 
 "head": { 
 "apiCode": "getCardId", 
 "sysId": "202402271432298822660001",
 "requestNo": "202407220215356714587788", 
 "version": "1.0", 
 "code": "SUCCESS", 
 "detail": "SUCCESS", 
 "sign": "50a7aca6d7a65f848535aaf6cbfa674583e103afea9db4863b6b47953670cf8***", 
 "keyEnc": "b25973f85c9ff6092b6647a6ed5603384e14a853c3a06b6cfde5ae55eb165***" 
 }, 
 "body":{ 
 "encrypt":"aB3OMZSBlWyaDsPMtU4w/4lI87EWiR1hPzEdBlp9WVvOTjeeX4ZxPy2o+9x1a***"
 } 
 }

16.Set No PIN Input limit

• ApiCode: noPinAmount

• Request Parameter

• The maximum single transaction amount that can be spent without entering a password.

  1. If it is 0, it means that the small amount purchase function without a password is turned off.

  2. The amount range is 0-700 US dollars.

  3. The unit of measurement is US dollars

No	Field	Type	Required	Notes
1	cardID	String	Y	Card ID
2	amount	number	Y	=0 and <=700 USD

• Request Message

Request Body Example:

Request Body Example

 {
    "cardID": "12455",
    "amount": 500
}

Request Message Example:

Request Message Example

{ 
 "head": { 
 "apiCode": "noPinAmount", 
 "sysId": "202402271432298822660001", 
 "requestNo": "202407220205543213878644", 
 "version": "1.0", 
 "sign": "29589585d30e6bfca3e2588f61d67cf7ff0567f4c5ccc79ef954da66326be51***", 
 "keyEnc": "7c819f5751420b267a32c6b1bb95735a327dcb20ca1c2abcafaa5125604a8***" 
 }, 
 "body":{ 
 "encrypt":"zcNZ5RFgBASAcOX5sRYiMSTaYN/3iNv3HA3/FXJmVkCnzkECPIpaw7daqowwv*******" 
 } 
 }

• Response Parameters

No	Field	Type	Required	Notes
1	amount	number	Y	amount

• Response Message

Response Body Example:

Response Body Example

 { 
 "amount":500
 } 

Response Message Example:

Response Message Example

{ 
 "head": { 
 "apiCode": "noPinAmount", 
 "sysId": "202402271432298822660001",
 "requestNo": "202407220215356714587788", 
 "version": "1.0", 
 "code": "SUCCESS", 
 "detail": "SUCCESS", 
 "sign": "50a7aca6d7a65f848535aaf6cbfa674583e103afea9db4863b6b47953670cf8***", 
 "keyEnc": "b25973f85c9ff6092b6647a6ed5603384e14a853c3a06b6cfde5ae55eb165***" 
 }, 
 "body":{ 
 "encrypt":"aB3OMZSBlWyaDsPMtU4w/4lI87EWiR1hPzEdBlp9WVvOTjeeX4ZxPy2o+9x1a***"
 } 
 }