KazePay
    KazePay
    • Introduction
    • Quick Guide
    • Virtual Card APIs
    • Physical Card APIs
    • Webhook APIs
    • Merchant APIs
    • Appendix

    Physical Card APIs

    1.Submit KYC information（Deprecated）#

    ApiCode: setUcardKyc
    Request Parameter
    NoFieldTypeRequiredNotes
    1emailStringYuser email
    2mobileNumberStringYuser phone number
    3mobilePrefixStringYmobile international dialing code(China 86, Korea 82, Japan 81 etc. )
    4mobilePrefixCountryStringYuser phone country code. ISO3166-2 2-digit country code. Example:MY
    5firstNameStringYContent must be in English. Example: Trump
    6lastNameStringYContent must be in English. Example: Donald
    7dateOfBirthStringYdate Of Birth: yyyy-MM-dd
    8addressLineStringYCustomer's residential address. Content must be in English. Maximum length: 140 characters.
    9cityStringYCustomer's city of residence, Example:Paris
    10countryCodeStringYCustomer's country of residence. ISO3166-2 2-digit country code. Example:MY
    11postCodeStringYExample: C2A2EX
    12stateStringYState
    13identificationTypeStringYAllowed values: PASSPORT ID_CARD
    14identificationNumberStringYidentification Number
    15identificationExpiryDateStringYidentification Expiry Date:yyyy-MM-dd
    16frontImgBase64StringYbase64 encoding of the front of the document
    17backImgBase64StringCbase64 encoding of the back of the document
    18handheldImgBase64StringYbase64 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
    NoFieldTypeRequiredNotes
    1encryptStringYReturn values: SUCCESS FAILED
    2statusStringYReturn 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
    NoFieldTypeRequiredNotes
    1emailStringYuser email
    2mobileNumberStringYuser phone number
    3mobilePrefixStringYmobile 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
    Shell
    Response Parameters
    NoFieldTypeRequiredNotes
    1encryptStringYReturn values: SUCCESS FAILED
    2fileIdStringYFile 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
    NoFieldTypeRequiredNotes
    1emailStringYuser email
    2mobileNumberStringYuser phone number
    3mobilePrefixStringYmobile international dialing code(China 86, Korea 82, Japan 81 etc. )
    4mobilePrefixCountryStringYuser phone country code. ISO3166-2 2-digit country code. Example:MY
    5firstNameStringYContent must be in English. Example: Trump
    6lastNameStringYContent must be in English. Example: Donald
    7dateOfBirthStringYdate Of Birth: yyyy-MM-dd
    8addressLineStringYCustomer's residential address. Content must be in English. Maximum length: 140 characters.
    9cityStringYCustomer's city of residence, Example:Paris
    10countryCodeStringYCustomer's country of residence. ISO3166-2 2-digit country code. Example:MY
    11postCodeStringYExample: C2A2EX
    12stateStringYState
    13identificationTypeStringYAllowed values: PASSPORT ID_CARD
    14identificationNumberStringYidentification Number
    15identificationExpiryDateStringYidentification Expiry Date:yyyy-MM-dd
    16frontImgFileIdStringYGet the file id by uploading the file through ApiCode=fileUpload
    17backImgFileIdStringCRequired for ID_CARD,Get the file id by uploading the file through ApiCode=fileUpload
    18handheldImgFileIdStringYGet 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
    NoFieldTypeRequiredNotes
    1encryptStringYReturn values: SUCCESS FAILED
    2statusStringYReturn 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
    NoFieldTypeRequiredNotes
    1emailStringYuser email
    2mobileNumberStringYuser phone number
    3mobilePrefixStringYmobile international dialing code(China 86, Korea 82, Japan 81 etc. )
    4mobilePrefixCountryStringYuser phone country code. ISO3166-2 2-digit country code. Example:MY
    5firstNameStringYContent must be in English. Example: Trump
    6lastNameStringYContent must be in English. Example: Donald
    7dateOfBirthStringYdate Of Birth: yyyy-MM-dd
    8addressLineStringYCustomer's residential address. Content must be in English. Maximum length: 140 characters.
    9cityStringYCustomer's city of residence, Example:Paris
    10countryCodeStringYCustomer's country of residence. ISO3166-2 2-digit country code. Example:MY
    11postCodeStringYExample: C2A2EX
    12stateStringYState
    13identificationTypeStringYAllowed values: PASSPORT ID_CARD
    14identificationNumberStringYidentification Number
    15identificationExpiryDateStringYidentification 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
    NoFieldTypeRequiredNotes
    1encryptStringYReturn values: SUCCESS FAILED
    2kycUrlStringYKYC 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
    NoFieldTypeRequiredNotes
    1emailStringYuser 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
    NoFieldTypeRequiredNotes
    1encryptStringYReturn values: SUCCESS FAILED
    2statusStringYKYC 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
    NoFieldTypeRequiredNotes
    1emailStringYuser email
    2cardNumberStringYCard number
    3autoActivebooleanYAllowed 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
    NoFieldTypeRequiredNotes
    1encryptStringYReturn values: SUCCESS FAILED
    2cardIDStringYCard 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
    NoFieldTypeRequiredNotes
    1cardIDStringYCard ID
    2activationCodeStringYactivation 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
    NoFieldTypeRequiredNotes
    1encryptStringYReturn values: SUCCESS FAILED
    2cardIDStringYCard ID
    3statusStringYCard 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
    NoFieldTypeRequiredNotes
    1cardIDStringYCard ID
    2pinStringYmust 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
    NoFieldTypeRequiredNotes
    1encryptStringYReturn 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
    NoFieldTypeRequiredNotes
    1cardIDStringYCard 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
    NoFieldTypeRequiredNotes
    1cardIDStringYCard ID
    2cardNoStringYBankcard Number
    3cardCvvStringYBankcard Cvv code, Only Virtual Card return this Field
    4expiryDateStringYBankcard Expiry Date(YYMM)
    5currencyStringYBankcard currency
    6userBankCardStatusStringYBankcard status
    7cardHolderEmailStringYuser email, should not be used
    8cardHolderMobileNumberStringYuser phone number,should not be used
    9cardHolderMobilePrefixStringYuser phone country code(China 86, Korea 82, Japan 81 etc. )
    10countryCodeStringYBilling Country
    11billingStateStringYBilling State
    12billingCityStringYBilling City
    13billingAddressStringYBilling Address
    14billingZipCodeStringYPostal 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
    NoFieldTypeRequiredNotes
    1cardIDStringYCard ID
    2currencyStringYCurrency (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
    NoFieldTypeRequiredNotes
    1cardIDStringYCard ID
    2currencyStringYCurrency (default USD)
    3avaBalanceDoubleYCard available balance
    4blockBalanceDoubleYCard 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
    NoFieldTypeRequiredNotes
    1cardIDStringYCard ID
    2currencyStringYCurrency (default USD)
    3amountDoubleYTop 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
    NoFieldTypeRequiredNotes
    1cardIDStringYCard ID
    2currencyStringYCurrency (default USD)
    3transactionIdStringYRequest unique transaction id
    4transactionStatusStringYRefer to Appendix Part 3
    5sendAmountStringYTop 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
    NoFieldTypeRequiredNotes
    1cardIDStringYCard ID
    2transactionIdStringNTransaction ID
    3pageSizeNumberNThe value range is [1,100], and the default value is 10
    4pageNumNumberNThe value range is [1,10], and the default value is 1
    5transactionStartTimeStringNfrom time(yyyy-MM-dd HH:mm:ss)
    6transactionEndTimeStringNend 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
    NoFieldTypeRequiredNotes
    1cardIDStringYCard ID
    2transactionIdStringYTransaction ID
    3transactionTimeStringYyyyy-MM-dd HH:mm:ss
    4cardCurrencyStringYCard currency type
    5cardCurrencyAmtDoubleYCard currency trans Amount
    6transCurrencyStringYTransaction currency type
    7transCurrencyAmtDoubleYTransaction currency trans Amount
    8feeCurrencyStringYCurrency of the transaction fee
    9feeDoubleYTransaction fee
    10transStatusStringYTransaction status
    11transTypeStringYTransaction type
    12merchantNameStringYMerchant name
    13respCodeStringYResponse Code
    14respCodeDescStringYResponse 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
    NoFieldTypeRequiredNotes
    1cardIDStringYCard ID
    2statusStringYAllowed 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
    NoFieldTypeRequiredNotes
    1cardIDStringYCard ID
    2statusStringYCard 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
    NoFieldTypeRequiredNotes
    1cardIDStringYCard 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
    NoFieldTypeRequiredNotes
    1cardIDStringYCard ID
    2statusStringYCard Status
    3refundAmtStringYRefund amount
    4currencyStringYCurrency (default USD)
    5txnIdStringYTransaction 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
    NoFieldTypeRequiredNotes
    1cardNoStringYcardNo
    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
    NoFieldTypeRequiredNotes
    1cardIDStringYCard ID
    2cardNoStringYcardNo
    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***"
 } 
 }

    #

    Modified at 2025-06-13 08:51:46
    Previous
    Virtual Card APIs
    Next
    Webhook APIs
    Built with