Virtual Card APIs

1.Apply Card

ApiCode: createCard

Request Parameter

No	Field	Type	Required	Notes
1	email	String	Y	user email, should not be used
2	mobileNumber	String	Y	user phone number,should not be used
3	mobilePrefix	String	Y	user phone country code(China 86, Korea 82, Japan 81 etc. )
4	cardBin	String	Y	Specispecify open card BIN, specific information can contact KazePay
5	cardLevel	String	N	Card level, with a default value of 01

Request Message

Request Body Example:

Request Body Example

 { 
 "email":"kazepay@kazepay.io",
 "mobileNumber":"108248888",
 "mobilePrefix":"60",
 "cardBin":"222929",
 "cardLevel":"01"
 }

Request Message Example:

Request Message Example

 { 
 "head": { 
 "apiCode": "createCard", 
 "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	status	String	Y	Apply for Card Status

Response Message

Response Body Example:

Request Message Example

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

Response Message Example:

Request Message Example

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

2.Check Card Activation Status

ApiCode: createCardQuery

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": "createCardQuery", 
 "sysId": "202402271432298822660001", 
 "requestNo": "202410270205231589690784", 
 "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	transactionStatus	String	Y	Card order status

Response Message

Response Body Example:

Response Body Example

 { 
 "cardID":"19181",
 "transactionStatus":"APPROVED"
 }

Response Message Example:

Response Message Example

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

3.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	Y	user email, should not be used
8	cardHolderMobileNumber	String	Y	user phone number,should not be used
9	cardHolderMobilePrefix	String	Y	user phone country code(China 86, Korea 82, Japan 81 etc. )
10	countryCode	String	Y	Billing Country
11	billingState	String	Y	Billing State
12	billingCity	String	Y	Billing City
13	billingAddress	String	Y	Billing Address
14	billingZipCode	String	Y	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***"
 } 
 }

4.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***"
 } 
 }

5.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	String	Y	Top up amount

Response Message

Response Body Example:

Response Body Example

 { 
 "cardID":"19181",
 "currency":"USD",
 "transactionId":"202410110952451141340673",
 "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***"
 } 
 }

6.Check Card Recharge Status

ApiCode: rechargeQuery

Request Parameter

No	Field	Type	Required	Notes
1	cardID	String	Y	Card ID
2	transactionId	String	Y	Request unique transaction id

Request Message

Request Body Example:

Request Body Example

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

Request Message Example:

Request Message Example

{ 
 "head": { 
 "apiCode": "rechargeQuery", 
 "sysId": "202402271432298822660001", 
 "requestNo": "202410270205894335892658", 
 "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	Request unique transaction id
3	transactionStatus	String	Y	Card order status

Response Message

Response Body Example:

Response Body Example

 { 
 "cardID":"19181",
 "transactionId":"202411111153141144980001",
 "transactionStatus":"APPROVED"
 }

Response Message Example:

Response Message Example

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

7.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	refundCurrency	String	C	Refund currency
14	refundAmount	Double	C	Refund amount
15	subList	List	C	Data collection
	subList[0].cardID	String	C	Card ID
	subList[0].transactionId	String	C	Transaction ID
	subList[0].transactionTime	String	C	yyyy-MM-dd HH:mm:ss
	subList[0].cardCurrency	String	C	Card currency type
	subList[0].cardCurrencyAmt	Double	C	Card currency trans Amount
	subList[0].transCurrency	String	C	Transaction currency type
	subList[0].transCurrencyAmt	Double	C	Transaction currency trans Amount
	subList[0].feeCurrency	String	C	Currency of the transaction fee
	subList[0].fee	Double	C	Transaction fee
	subList[0].transStatus	String	C	Transaction status
	subList[0].transType	String	C	Transaction type
	subList[0].merchantName	String	C	Merchant name

Response Message

Response Body Example:

Response Body Example

  [{
      "cardCurrencyAmt": 359.71,
      "fee": -9.74,
      "feeCurrency": "HKD",
      "transactionTime": "2025-03-24 21:37:12",
      "transCurrency": "MYR",
      "transactionId": "K202503123345",
      "merchantName": "Shell",
      "cardCurrency": "HKD",
      "transType": "AUTH",
      "cardID": "K-123456",
      "refundCurrency": "HKD",
      "transCurrencyAmt": 200,
      "transStatus": "APPROVED",
      "refundAmount": 185.86,
		  "subList": [
          {
            "transactionType": "AUTH",
            "cardCurrency": "HKD",
            "transactionCurrency": "MYR",
            "transactionStatus": "CONFIRM",
            "cardId": "K-123456",
            "transactionAmount": 200,
            "fee": 458,
            "feeCurrency": "HKD",
            "transactionDate": "2025-03-24 21:37:12",
            "cardTransactionAmount": 359.71,
            "transactionId": "K202503123345",
            "transactionIdSub": "2025032421314789"
          },
          {
            "transactionType": "CLEARING",
            "cardCurrency": "HKD",
            "transactionCurrency": "MYR",
            "transactionStatus": "APPROVED",
            "cardId": "K-123456",
            "transactionAmount": 97.09,
            "fee": 458,
            "feeCurrency": "HKD",
            "transactionDate": "2025-03-26 19:36:44",
            "cardTransactionAmount": 173.85,
            "transactionId": "K202503123345",
            "transactionIdSub": "2025032421314790"
          }
        ]
  },
      ...
  ],
  "encrypt": "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***"
 } 
 }

8.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": "updCardStatus", 
 "sysId": "202402271432298822660001",
 "requestNo": "202407220215356714587788", 
 "version": "1.0", 
 "code": "SUCCESS", 
 "detail": "SUCCESS", 
 "sign": "50a7aca6d7a65f848535aaf6cbfa674583e103afea9db4863b6b47953670cf8***", 
 "keyEnc": "b25973f85c9ff6092b6647a6ed5603384e14a853c3a06b6cfde5ae55eb165***" 
 }, 
 "body":{ 
 "encrypt":"aB3OMZSBlWyaDsPMtU4w/4lI87EWiR1hPzEdBlp9WVvOTjeeX4ZxPy2o+9x1a***"
 } 
 }

9.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": "closeCard", 
 "sysId": "202402271432298822660001",
 "requestNo": "202407220623012824582948", 
 "version": "1.0", 
 "code": "SUCCESS", 
 "detail": "SUCCESS", 
 "sign": "50a7aca6d7a65f848535aaf6cbfa674583e103afea9db4863b6b47953670cf8***", 
 "keyEnc": "b25973f85c9ff6092b6647a6ed5603384e14a853c3a06b6cfde5ae55eb165***" 
 }, 
 "body":{ 
 "encrypt":"aB3OMZSBlWyaDsPMtU4w/4lI87EWiR1hPzEdBlp9WVvOTjeeX4ZxPy2o+9x1a***"
 } 
 }

10.Modify card information

ApiCode: cardSetting

Applicable cardbin: 4146

Request Parameter

No	Field	Type	Required	Notes
1	cardID	String	Y	Card ID
2	email	String	N	user email(At least one of email or phone number is required)
3	mobileNumber	String	N	user phone number,should not be used(At least one of email or phone number is required)
4	mobilePrefix	String	N	user phone country code(China 86, Korea 82, Japan 81 etc. )

Request Message

Request Body Example:

Request Body Example

 { 
 "cardID":"19181",
 "email":"kazepay@kazepay.io",
 "mobileNumber":"108248888",
 "mobilePrefix":"60"
 }

Request Message Example:

Request Message Example

{ 
 "head": { 
 "apiCode": "cardSetting", 
 "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	SUCCESS/FAIL

Response Message

Response Body Example:

Response Body Example

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

Response Message Example:

Response Message Example

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

11.Set Cardholder Information

ApiCode: setCardholder

Applicable cardbin: 461199

Request Parameter

No	Field	Required	Type	Length	Notes
1	firstName	Y	String	64	Cardholder Name
2	lastName	Y	String	64	Last name of the cardholder
3	email	Y	String	1	Email(The cardholder's email address is unique, and each email address can only be bound to one cardholder)
4	mobilePrefix	Y	String	10	user phone country code(China 86, Korea 82, Japan 81 etc. )
5	mobileNumber	Y	String	20	user phone number,should not be used
6	birthDate	Y	String	10	Date of Birth
7	countryCode	Y	String	3	Billing country code (the country code of the cardholder's bill, such as CNH for China)
8	billingState	Y	String	64	Billing Province/State, the province/state to which the cardholder's bill belongs. When the country is the United States, this field transmits the two-letter state code (such as: AR, see Appendix: Two-letter State Codes for the United States)
9	billingCity	Y	String	64	Cardholder's billing city
10	billingAddress	Y	String	64	Billing Address
11	billingZipCode	Y	String	64	Billing Postal Code

Request Message

Request Body Example:

Request Body Example

 {
    "firstName":"zhen",
    "lastName":"tian",
    "email":"kazepay@gmail.com",
    "mobilePrefix":"60",
    "mobile":"15425444",
    "birthDate":"1996-01-01",
    "countryCode": "MYS",
    "billingState": "Kuala Lumpur",
    "billingCity": "Kuala Lumpur",
    "billingAddress": "No. 123, Jalan Ampang, 50450",
    "billingZipCode":"123456"
}

Request Message Example:

Request Message Example

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

Response Parameters

No	Field	Type	Required	Notes
1	cardUserId	String	Y	User ID

Response Message

Response Body Example:

Response Body Example

 { 
 "cardUserId":"19181"
 }

Response Message Example:

Response Message Example

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

12.Get Cardholder Information

ApiCode: getCardholder

Applicable cardbin: 461199

Request Parameter

No	Field	Type	Required	Notes
1	email	String	Y	email

Request Message

Request Body Example:

Request Body Example

 {
    
    "email":"kazepay@gmail.com"
}

Request Message Example:

Request Message Example

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

Response Parameters

No	Field	Required	Type	Notes
1	firstName	Y	String	Cardholder Name
2	lastName	Y	String	Last name of the cardholder
3	email	Y	String	Email
4	mobilePrefix	Y	String	user phone country code
5	mobileNumber	Y	String	user phone number
6	birthDate	Y	String	Date of Birth
7	countryCode	Y	String	Billing country code
8	billingState	Y	String	Billing Province/State
9	billingCity	Y	String	Cardholder's billing city
10	billingAddress	Y	String	Billing Address
11	billingZipCode	Y	String	Billing Postal Code
12	cardUserId	Y	String	User Id

Response Message

Response Body Example:

Response Body Example

{
    "firstName":"zhen",
    "lastName":"tian",
    "email":"kazepay@gmail.com",
    "mobilePrefix":"60",
    "mobile":"15425444",
    "birthDate":"1996-01-01",
    "countryCode": "MYS",
    "billingState": "Kuala Lumpur",
    "billingCity": "Kuala Lumpur",
    "billingAddress": "No. 123, Jalan Ampang, 50450",
    "billingZipCode":"123456",
    "cardUserId":"123456"
}

Response Message Example:

Response Message Example

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

Virtual Card APIs

1.Apply Card#

2.Check Card Activation Status#

3.Query Card Information#

4.Query Card Balance#

5.Recharge Card#

6.Check Card Recharge Status#

7.Query Card Transactions#

8.Set Card Status#

9.Close Card#

10.Modify card information#

11.Set Cardholder Information#

12.Get Cardholder Information#

#

1.Apply Card

2.Check Card Activation Status

3.Query Card Information

4.Query Card Balance

5.Recharge Card

6.Check Card Recharge Status

7.Query Card Transactions

8.Set Card Status

9.Close Card

10.Modify card information

11.Set Cardholder Information

12.Get Cardholder Information