Virtual Card APIs
1.Apply Card#
| 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 |
{
"email":"kazepay@kazepay.io",
"mobileNumber":"108248888",
"mobilePrefix":"60",
"cardBin":"222929",
"cardLevel":"01"
}
{
"head": {
"apiCode": "createCard",
"sysId": "202402271432298822660001",
"requestNo": "2024022810200867360001",
"version": "1.0",
"sign": "29589585d30e6bfca3e2588f61d67cf7ff0567f4c5ccc79ef954da66326be51***",
"keyEnc": "7c819f5751420b267a32c6b1bb95735a327dcb20ca1c2abcafaa5125604a8***"
},
"body":{
"encrypt":"zcNZ5RFgBASAcOX5sRYiMSTaYN/3iNv3HA3/FXJmVkCnzkECPIpaw7daqowwv*******"
}
}
| No | Field | Type | Required | Notes |
|---|
| 1 | cardID | String | Y | Card ID |
| 2 | status | String | Y | Apply for Card Status |
{
"cardID":"19181",
"status":"AUDITING"
}
{
"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#
| No | Field | Type | Required | Notes |
|---|
| 1 | cardID | String | Y | Card ID |
{
"head": {
"apiCode": "createCardQuery",
"sysId": "202402271432298822660001",
"requestNo": "202410270205231589690784",
"version": "1.0",
"sign": "29589585d30e6bfca3e2588f61d67cf7ff0567f4c5ccc79ef954da66326be51***",
"keyEnc": "7c819f5751420b267a32c6b1bb95735a327dcb20ca1c2abcafaa5125604a8***"
},
"body":{
"encrypt":"zcNZ5RFgBASAcOX5sRYiMSTaYN/3iNv3HA3/FXJmVkCnzkECPIpaw7daqowwv*******"
}
}
| No | Field | Type | Required | Notes |
|---|
| 1 | cardID | String | Y | Card ID |
| 2 | transactionStatus | String | Y | Card order status |
{
"cardID":"19181",
"transactionStatus":"APPROVED"
}
{
"head": {
"apiCode": "createCardQuery",
"sysId": "202402271432298822660001",
"requestNo": "202410270205231589690784",
"version": "1.0",
"code": "SUCCESS",
"detail": "SUCCESS",
"sign": "50a7aca6d7a65f848535aaf6cbfa674583e103afea9db4863b6b47953670cf8***",
"keyEnc": "b25973f85c9ff6092b6647a6ed5603384e14a853c3a06b6cfde5ae55eb165***"
},
"body":{
"encrypt":"aB3OMZSBlWyaDsPMtU4w/4lI87EWiR1hPzEdBlp9WVvOTjeeX4ZxPy2o+9x1a***"
}
}
| No | Field | Type | Required | Notes |
|---|
| 1 | cardID | String | Y | Card ID |
{
"head": {
"apiCode": "queryCard",
"sysId": "202402271432298822660001",
"requestNo": "2024022810200867360001",
"version": "1.0",
"sign": "29589585d30e6bfca3e2588f61d67cf7ff0567f4c5ccc79ef954da66326be51***",
"keyEnc": "7c819f5751420b267a32c6b1bb95735a327dcb20ca1c2abcafaa5125604a8***"
},
"body":{
"encrypt":"zcNZ5RFgBASAcOX5sRYiMSTaYN/3iNv3HA3/FXJmVkCnzkECPIpaw7daqowwv*******"
}
}
| 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 |
{
"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"
}
{
"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#
| No | Field | Type | Required | Notes |
|---|
| 1 | cardID | String | Y | Card ID |
| 2 | currency | String | Y | Currency (default USD) |
{
"cardID":"19181",
"currency":"USD"
}
{
"head": {
"apiCode": "cardBalance",
"sysId": "202402271432298822660001",
"requestNo": "202404220205221238690954",
"version": "1.0",
"sign": "29589585d30e6bfca3e2588f61d67cf7ff0567f4c5ccc79ef954da66326be51***",
"keyEnc": "7c819f5751420b267a32c6b1bb95735a327dcb20ca1c2abcafaa5125604a8***"
},
"body":{
"encrypt":"zcNZ5RFgBASAcOX5sRYiMSTaYN/3iNv3HA3/FXJmVkCnzkECPIpaw7daqowwv*******"
}
}
| 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 |
{
"cardID":"19181",
"currency":"USD",
"avaBalance":18506.25,
"blockBalance":2020.00
}
{
"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#
| 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 |
{
"cardID":"19181",
"currency":"USD",
"amount":5000.00
}
{
"head": {
"apiCode": "cardRecharge",
"sysId": "202402271432298822660001",
"requestNo": "202404240210584029864396",
"version": "1.0",
"sign": "29589585d30e6bfca3e2588f61d67cf7ff0567f4c5ccc79ef954da66326be51***",
"keyEnc": "7c819f5751420b267a32c6b1bb95735a327dcb20ca1c2abcafaa5125604a8***"
},
"body":{
"encrypt":"zcNZ5RFgBASAcOX5sRYiMSTaYN/3iNv3HA3/FXJmVkCnzkECPIpaw7daqowwv*******"
}
}
| 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 |
{
"cardID":"19181",
"currency":"USD",
"transactionId":"202410110952451141340673",
"transactionStatus":"PENDING",
"sendAmount":"5000.00"
}
{
"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#
| No | Field | Type | Required | Notes |
|---|
| 1 | cardID | String | Y | Card ID |
| 2 | transactionId | String | Y | Request unique transaction id |
{
"cardID":"19181",
"transactionId":"202411111153141144980001"
}
{
"head": {
"apiCode": "rechargeQuery",
"sysId": "202402271432298822660001",
"requestNo": "202410270205894335892658",
"version": "1.0",
"sign": "29589585d30e6bfca3e2588f61d67cf7ff0567f4c5ccc79ef954da66326be51***",
"keyEnc": "7c819f5751420b267a32c6b1bb95735a327dcb20ca1c2abcafaa5125604a8***"
},
"body":{
"encrypt":"zcNZ5RFgBASAcOX5sRYiMSTaYN/3iNv3HA3/FXJmVkCnzkECPIpaw7daqowwv*******"
}
}
| 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 |
{
"cardID":"19181",
"transactionId":"202411111153141144980001",
"transactionStatus":"APPROVED"
}
{
"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
| 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) |
{
"cardID":"19181",
"transactionId":"LM2312151602393234580"
}
{
"head": {
"apiCode": "queryTransactions",
"sysId": "202407271432298822660001",
"requestNo": "2024022810200867360001",
"version": "1.0",
"sign": "29589585d30e6bfca3e2588f61d67cf7ff0567f4c5ccc79ef954da66326be51***",
"keyEnc": "7c819f5751420b267a32c6b1bb95735a327dcb20ca1c2abcafaa5125604a8***"
},
"body":{
"encrypt":"zcNZ5RFgBASAcOX5sRYiMSTaYN/3iNv3HA3/FXJmVkCnzkECPIpaw7daqowwv*******"
}
}
| 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 |
[{
"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"
},
...
]
{
"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#
| No | Field | Type | Required | Notes |
|---|
| 1 | cardID | String | Y | Card ID |
| 2 | status | String | Y | Allowed values: ACTIVE INACTIVE |
{
"cardID":"19181",
"status":"INACTIVE"
}
{
"head": {
"apiCode": "updCardStatus",
"sysId": "202402271432298822660001",
"requestNo": "202407220205543213878644",
"version": "1.0",
"sign": "29589585d30e6bfca3e2588f61d67cf7ff0567f4c5ccc79ef954da66326be51***",
"keyEnc": "7c819f5751420b267a32c6b1bb95735a327dcb20ca1c2abcafaa5125604a8***"
},
"body":{
"encrypt":"zcNZ5RFgBASAcOX5sRYiMSTaYN/3iNv3HA3/FXJmVkCnzkECPIpaw7daqowwv*******"
}
}
| No | Field | Type | Required | Notes |
|---|
| 1 | cardID | String | Y | Card ID |
| 2 | status | String | Y | Card Status |
{
"cardID":"19181",
"status":"INACTIVE"
}
{
"head": {
"apiCode": "cardBalance",
"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.| No | Field | Type | Required | Notes |
|---|
| 1 | cardID | String | Y | Card ID |
{
"head": {
"apiCode": "closeCard",
"sysId": "202402271432298822660001",
"requestNo": "202407220611314533251902",
"version": "1.0",
"sign": "29589585d30e6bfca3e2588f61d67cf7ff0567f4c5ccc79ef954da66326be51***",
"keyEnc": "7c819f5751420b267a32c6b1bb95735a327dcb20ca1c2abcafaa5125604a8***"
},
"body":{
"encrypt":"zcNZ5RFgBASAcOX5sRYiMSTaYN/3iNv3HA3/FXJmVkCnzkECPIpaw7daqowwv*******"
}
}
| 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 |
{
"cardID":"19181",
"status":"CLOSE_PROCESSING",
"refundAmt":"65.22",
"currency":"USD",
"txnId":"2412111444075320115"
}
{
"head": {
"apiCode": "cardBalance",
"sysId": "202402271432298822660001",
"requestNo": "202407220623012824582948",
"version": "1.0",
"code": "SUCCESS",
"detail": "SUCCESS",
"sign": "50a7aca6d7a65f848535aaf6cbfa674583e103afea9db4863b6b47953670cf8***",
"keyEnc": "b25973f85c9ff6092b6647a6ed5603384e14a853c3a06b6cfde5ae55eb165***"
},
"body":{
"encrypt":"aB3OMZSBlWyaDsPMtU4w/4lI87EWiR1hPzEdBlp9WVvOTjeeX4ZxPy2o+9x1a***"
}
}
Modified at 2025-01-16 12:00:11
