Card Management

Supported card bins

No longer maintained new param from 2025-04-19. The interface can always be used.

POST /merchant/core/mcb/card/cardTypes

Request

Param	Type	Require	Remark

Response

Param	Type	Required	Remark
cardTypeId	Long	true	ID
organization	String	true	Card organization. Visa； MasterCard； Discover
bankCardBin	String	true	BIN
type	String	true	Card type. Virtual； Physical
typeStr	String	true	Card Type desc
cardName	String	true	Card name
cardDesc	String	true	Card desc
cardPrice	Bigdecimal	true	Price
cardPriceCurrency	String	true	Card price currency
support	List	true	Supporting organizations. For reference only
supportHolderRegin	List	true	Country/region codes supported by cardholder information
supportHolderAreaCode	List	true	Mobile phone area codes supported by cardholder information
needCardHolder	Boolean	true	Cardholder required
needDepositForActiveCard	Boolean	true	When you open the card, you need to top up
depositAmountMinQuotaForActiveCard	Bigdecimal	true	Minimum recharge amount when opening a card
depositAmountMaxQuotaForActiveCard	Bigdecimal	true	Maximum recharge amount when opening a card
fiatCurrency	String	true	Card currency
status	String	true	Status. online: on the shelf; offline: off the shelf
extFieldVO	Object	true
extFieldVO.rechargeCurrencyInfos	List	true
rechargeCurrencyInfos.currency	String	true	Supported currencies for recharge
rechargeCurrencyInfos.rechargeMinQuota	Bigdecimal	true	Minimum recharge amount
rechargeCurrencyInfos.rechargeMaxQuota	Bigdecimal	true	Maximum recharge amount
rechargeCurrencyInfos.rechargeFeeRate	Bigdecimal	true	Recharge fee rate 1=1%
rechargeCurrencyInfos.rechargeFee	Bigdecimal	true	Fixed recharge fee
rechargeCurrencyInfos.digital	Integer	true	Digital

Example Response

{
    "success": true,
    "code": 200,
    "msg": "Success",
    "data":
    [
        {
            "cardTypeId": 111002,
            "organization": "Visa",
            "bankCardBin": "4866",
            "type": "Virtual",
            "typeStr": "Virtual Card",
            "cardName": "4866**",
            "cardDesc": "Adobe,Aliexpress,Amazon.（暂不支持PayPal, Grab, ONLYFANS, Patreon, Etsy商户消费，否则会立刻销卡并冻结；需要Apple服务可选择5319卡片；）",
            "cardPrice": "10",
            "cardPriceCurrency": "USD",
            "support":
            [
                "Adobe",
                "Aliexpress"
            ],
            "supportHolderRegin":
            [
                "US"
            ],
            "supportHolderAreaCode":
            [
                "+60",
                "+1"
            ],
            "needCardHolder": false,
            "needDepositForActiveCard": true,
            "depositAmountMinQuotaForActiveCard": "10",
            "depositAmountMaxQuotaForActiveCard": "100000",
            "fiatCurrency": "USD",
            "status": "online",
            "extFieldVO":
            {
                "rechargeCurrencyInfos":
                [
                    {
                        "currency": "USD",
                        "rechargeMinQuota": "20",
                        "rechargeMaxQuota": "100",
                        "rechargeFeeRate": "1",
                        "rechargeFee": "1",
                        "digital": 6
                    }
                ]
            }
        }
    ]
}

Supported card bins-v2

POST /merchant/core/mcb/card/v2/cardTypes

Request

Param	Type	Require	Remark

Response

Param	Type	Required	Remark
cardTypeId	Long	true	ID
organization	String	true	Card organization. Visa； MasterCard； Discover
country	String	true	Issue country
bankCardBin	String	true	Card Bin
type	String	true	Card type. Virtual； Physical
typeStr	String	true	Card Type desc
cardName	String	true	Card name
cardDesc	String	true	Card desc
cardPrice	Bigdecimal	true	Price
cardPriceCurrency	String	true	Card price currency
support	List	true	Supporting organizations. For reference only
supportHolderRegin	List	true	Country/region codes supported by cardholder information
supportHolderAreaCode	List	true	Mobile phone area codes supported by cardholder information
needCardHolder	Boolean	true	Cardholder required
needDepositForActiveCard	Boolean	true	When you open the card, you need to top up
depositAmountMinQuotaForActiveCard	BigDecimal	true	Minimum recharge amount when opening a card
depositAmountMaxQuotaForActiveCard	BigDecimal	true	Maximum recharge amount when opening a card
fiatCurrency	String	true	Card currency
maxCount	Integer	true	Maximum number of cards purchased
status	String	true	Status. online: on the shelf; offline: off the shelf
rechargeCurrency	String	true	Supported currencies for recharge
rechargeMinQuota	BigDecimal	true	Minimum recharge amount
rechargeMaxQuota	BigDecimal	true	Maximum recharge amount
rechargeFeeRate	BigDecimal	true	Recharge fee rate 1=1%
rechargeFixedFee	BigDecimal	true	Fixed recharge fee
rechargeDigital	Integer	true	Digital
enableActiveCard	Boolean	true	Whether to enable the card opening function
enableDeposit	Boolean	true	Whether to enable the recharge function
enableFreeze	Boolean	true	Whether to enable the freeze function
enableUnFreeze	Boolean	true	Whether to enable the defrost function

Example Response

{
    "success": true,
    "code": 200,
    "msg": "Success",
    "data":
    [
        {
            "cardTypeId": 111002,
            "organization": "Visa",
            "country": "US",
            "bankCardBin": "4866",
            "type": "Virtual",
            "typeStr": "Virtual Card",
            "cardName": "4866**",
            "cardDesc": "Adobe,Aliexpress,Amazon.（暂不支持PayPal, Grab, ONLYFANS, Patreon, Etsy商户消费，否则会立刻销卡并冻结；需要Apple服务可选择5319卡片；）",
            "cardPrice": "10",
            "cardPriceCurrency": "USD",
            "support":
            [
                "Adobe",
                "Aliexpress"
            ],
            "supportHolderRegin":
            [
                "US"
            ],
            "supportHolderAreaCode":
            [
                "+60",
                "+1"
            ],
            "needCardHolder": false,
            "needDepositForActiveCard": true,
            "depositAmountMinQuotaForActiveCard": "10",
            "depositAmountMaxQuotaForActiveCard": "100000",
            "fiatCurrency": "USD",
            "maxCount": 100,
            "status": "online",
            "rechargeCurrency": "USD",
            "rechargeMinQuota": 20,
            "rechargeMaxQuota": 100000,
            "rechargeFeeRate": 1,
            "rechargeFixedFee": 0,
            "rechargeDigital": 2,
            "enableActiveCard": true,
            "enableDeposit": true,
            "enableFreeze": true,
            "enableUnFreeze": true
        }
    ]
}

Open Card

CardNo will be returned only when the card is successfully opened (status=success)

POST /merchant/core/mcb/card/openCard

Request

Param	Type	Required	Remark
merchantOrderNo	String	true	Merchant order number. length[20...25]
holderId	Long	false	Cardholder ID
cardTypeId	Long	true	Card type ID
amount	BigDecimal	false	The amount of top-up when opening the card. If not passed, the default value is equal to depositAmountMinQuotaForActiveCard (if the card BIN requires a first top-up) Value range: /merchant/core/mcb/card/cardTypes interface depositAmountMinQuotaForActiveCard <= amount <= depositAmountMaxQuotaForActiveCard

Response

Param	Type	Required	Rmark
orderNo	String	true	Platform order number
merchantOrderNo	String	true	Merchant order number
cardNo	String	false	Bank Card ID
currency	String	true	Currency
amount	BigDecimal	true	Amount
fee	BigDecimal	true	Fee
receivedAmount	BigDecimal	true	Received Amount
receivedCurrency	String	true	Received Currency
type	String	true	Type. create: Open card;
status	String	true	Status. wait_process: pending; processing: processing; success: success; fail: failure
remark	String	true	Remark
transactionTime	Long	true	Transaction time. Millisecond timestamp

Example Response

{
    "success": true,
    "code": 200,
    "msg": "Success",
    "data":
    [
        {
            "orderNo": "1852379830190366720",
            "merchantOrderNo": "T1852379826671345664",
            "cardNo": null,
            "currency": "USD",
            "amount": "15",
            "fee": "0",
            "receivedAmount": "0",
            "receivedCurrency": "USD",
            "type": "create",
            "status": "processing",
            "remark": null,
            "transactionTime": 1730476741729
        }
    ]
}

Card Info

POST /merchant/core/mcb/card/info

Request

Param	Type	Required	Remark
cardNo	String	true	Bank Card ID
onlySimpleInfo	Boolean	false	Whether to return only the basic information of the card. Does not include the balance. Default is true

Response

Param	Type	Required	Remark
holderId	Long	false	Cardholder ID
cardNo	String	true	Bank Card ID
cardNumber	String	true	Bank Card Number
cvv	String	true	cvv. The merchant's public key is encrypted and returned, and the merchant's private key is used to decrypt
validPeriod	String	true	Validity period. The merchant's public key is encrypted and returned, and the merchant's private key is used to decrypt
status	String	true	Status. Normal: Normal; Freeze: Freeze; Freezing: Freezing in review; UnFreezing: Unfreezing canceling：Canceling cancel：Canceled
statusStr	String	true	Status remark
bindTime	Long	true	Card opening time. Millisecond timestamp
remark	String	false	Remark
balanceInfo	Object	false	Card balance information
balanceInfo.cardNo	String	true	Bank Card ID
balanceInfo.amount	BigDecimal	true	Available balance
balanceInfo.usedAmount	BigDecimal	true	Amount used. some cards bin not support
balanceInfo.currency	String	true	Currency

Example Response

{
    "success": true,
    "code": 200,
    "msg": "Success",
    "data":
    {
        "holderId": 10090,
        "cardNo": "FC202408181555232422322004",
        "cardNumber": "202404000000000083",
        "cvv": "bQoXms9ScNxy37b1JgyP1tJuFiAcGl6d+7jqn7LTZRzQMXjn00zaa/xKJp/8sotkcBjl/L/6LSImxhnF+yg6V3aDft+v1ikkYBdY9Wco042o/uPyUNtr0xW786ENyB8Z84teK3vWtLeU/TbixEygxrxl/ilE+COmJOItWCGE6bs=",
        "validPeriod": "gQldrvKSV3cWXuCbrUgtVF5EsCgxEAZQuivEuddeoo5M+5bF0AiJJbw8PWvvZZerRmcOmv/0dRv8uyeaSbUmCyQrDn6cploG60lCxGfnzSopv5pEO4UrK071tNzIa++mZ4IZ4tvtlMYlwo+y3d9JhIareLM21E1mH7aPn+WOk50=",
        "status": "cancel",
        "statusStr": "Canceled",
        "bindTime": 1723997214000,
        "remark": null,
        "balanceInfo":
        {
            "cardNo": "FC202408181555232422322004",
            "amount": "10",
            "usedAmount": "1",
            "currency": "USD"
        }
    }
}

Card Balance

POST /merchant/core/mcb/card/balanceInfo

Reuqest

Param	Type	Required	Remark
cardNo	String	true	Bank Card ID

Response

Param	Type	Required	Remark
cardNo	String	true	Bank Card ID
amount	BigDecimal	true	Available balance
usedAmount	BigDecimal	true	Amount used. some cards bin not support
currency	String	true	Currency

Example Response

{
    "success": true,
    "code": 200,
    "msg": "Success",
    "data":
    {
        "cardNo": "FC202408181555232422322004",
        "amount": "10",
        "usedAmount": "1",
        "currency": "USD"
    }
}

Freeze

POST /merchant/core/mcb/card/freeze

Request

Param	Type	Required	Remark
cardNo	String	true	Bank Card ID

Response

Param	Type	Required	Remark
status	String	true	Status. processing: processing; success: success; fail: failure;
statusStr	String	true	Status remark

Example Response

{
    "success": true,
    "code": 200,
    "msg": "Success",
    "data":
    {
        "status": "success",
        "statusStr": "成功"
    }
}

Unfreeze

POST /merchant/core/mcb/card/unfreeze

Request

Param	Type	Required	Remark
cardNo	String	true	Bank Card ID

Response

Param	Type	Required	Remark
status	String	true	Status. processing: processing; success: success; fail: failure;
statusStr	String	true	Status remark

Example Response

{
    "success": true,
    "code": 200,
    "msg": "Success",
    "data":
    {
        "status": "success",
        "statusStr": "成功"
    }
}

Deposit

POST /merchant/core/mcb/card/deposit

Request

Param	Type	Required	Remark
cardNo	String	true	Bank Card ID
merchantOrderNo	String	true	Merchant order number. length[20...25]
amount	BigDecimal	true	Deposit Amount

Response

Param	Type	Required	Remark
orderNo	String	true	Platform order number
merchantOrderNo	String	true	Merchant order number
cardNo	String	true	Bank Card ID
currency	String	true	Currency
amount	BigDecimal	true	Amount
fee	BigDecimal	true	Fee
receivedAmount	BigDecimal	false	Amount received. status=success returns
receivedCurrency	String	false	The currency of the account. status=success is returned
type	String	true	Type. deposit: Deposit;
status	String	true	Status. wait_process: pending; processing: processing; success: success; fail: failure
remark	String	false	Transaction Notes
transactionTime	Long	true	Transaction time. Millisecond timestamp

Example Response

{
    "success": true,
    "code": 200,
    "msg": "Success",
    "data":
    {
        "orderNo": "1852379830190366720",
        "merchantOrderNo": "T1852379826671345664",
        "cardNo": "38928421021320391244",
        "currency": "USD",
        "amount": "15",
        "fee": "0",
        "receivedAmount": "0",
        "receivedCurrency": "USD",
        "type": "deposit",
        "status": "processing",
        "remark": "Card Deposit",
        "transactionTime": 1730476742000
    }
}

Card Transaction

POST /merchant/core/mcb/card/transaction

Request

Param	Type	Required	Remark
pageNum	Integer	true	Current page. Default is 1
pageSize	Integer	true	Number of pages per page. Default 10, maximum 100
type	String	true	Type. create: Open card； deposit: Deposit; cancel: Cancel Card;
merchantOrderNo	String	false	Merchant order number
orderNo	String	false	Platform order number
cardNo	String	false	Bank Card ID
startTime	Long	false	Start trading time. Milliseconds timestamp
endTime	Long	false	End trading time. Millisecond timestamp

Response

Param	Type	Required	Remark
orderNo	String	true	Platform order number
merchantOrderNo	String	false	Merchant order number
cardNo	String	false	Bank Card ID
currency	String	true	Currency
amount	BigDecimal	true	Amount
fee	BigDecimal	true	Fee
receivedAmount	BigDecimal	false	Received Amount
receivedCurrency	String	false	Received Currency
type	String	true	Type. create: Open card； deposit: Deposit; cancel: Cancel Card;
status	String	true	Status. wait_process: pending; processing: processing; success: success; fail: failure
remark	String	false	Remark
transactionTime	Long	true	Transaction time. Millisecond timestamp

Example Response

{
    "success": true,
    "code": 200,
    "msg": "Success",
    "data":
    {
        "total": 1,
        "records":
        [
            {
                "orderNo": "1852379830190366720",
                "merchantOrderNo": "T1852379826671345664",
                "cardNo": null,
                "currency": "USD",
                "amount": "15",
                "fee": "0",
                "receivedAmount": "0",
                "receivedCurrency": "USD",
                "type": "create",
                "status": "processing",
                "remark": null,
                "transactionTime": 1730476742000
            }
        ]
    }
}

Card Auth Transaction

POST /merchant/core/mcb/card/authTransaction

Request

Param	Type	Required	Remark
pageNum	Integer	true	Current page. Default is 1
pageSize	Integer	true	Number of pages per page. Default 10, maximum 100
type	String	false	type. auth: pre-authorization; correct_auth: pre-authorization correction; correct_refund: refund correction; refund: refund; verification: verification; Void: revocation;
tradeNo	String	false	Transaction serial number
cardNo	String	false	Bank Card ID
startTime	Long	false	Start trading time. Milliseconds timestamp
endTime	Long	false	End trading time. Millisecond timestamp

Response

Param	Type	Required	Remark
cardNo	String	true	Bank Card ID
tradeNo	String	true	Transaction serial number
originTradeNo	String	false	Origin transaction serial number
currency	String	false	Currency
amount	BigDecimal	false	Amount
authorizedAmount	BigDecimal	true	Authorized amount
authorizedCurrency	String	true	Authorized currency
fee	BigDecimal	true	Authorization fee
feeCurrency	String	false	Authorization fee currency
crossBoardFee	BigDecimal	true	Cross board fee
crossBoardFeeCurrency	String	false	Cross board fee currency
settleAmount	BigDecimal	false	Settlement amount. Pushed after receiving settlement information
settleCurrency	String	false	Settlement currency. Pushed after receiving settlement information
settleDate	Long	false	Settlement date. Millisecond timestamp
merchantName	String	true	Merchant name
type	String	true	type. auth: pre-authorization; correct_auth: pre-authorization correction; correct_refund: refund correction; refund: refund; verification: verification; Void: revocation;
typeStr	String	true	Type remark
status	String	true	Status. authorized: authorized; revoked: revoked; failed: failed; succeed: successful
statusStr	String	true	Status remark
description	String	true	Transaction Description
transactionTime	Long	true	Transaction time. Millisecond timestamp

Example Response

{
    "success": true,
    "code": 200,
    "msg": "Success",
    "data":
    {
        "total": 1563,
        "records":
        [
            {
                "cardNo": "1242352328671924231",
                "tradeNo": "trans1232435363435463432",
                "originTradeNo": null,
                "currency": "CNY",
                "amount": "16.96",
                "authorizedAmount": "2.45",
                "authorizedCurrency": "USD",
                "fee": "0.5",
                "feeCurrency": "USD",
                "crossBoardFee": "0",
                "crossBoardFeeCurrency": null,
                "settleAmount": 0,
                "settleCurrency": null,
                "settleDate": null,
                "merchantName": "ALP*Mr Rice 1223",
                "type": "auth",
                "typeStr": "授权",
                "status": "authorized",
                "statusStr": "已授权",
                "transactionTime": 1729422898000,
                "description": "Auth"
            }
        ]
    }
}

Card 3ds Transaction

POST /merchant/core/mcb/card/third3dsTransaction

Request

Param	Type	Required	Remark
pageNum	Integer	true	Current page. Default 1
pageSize	Integer	true	Number of pages per page. Default 10, maximum 100
type	String	false	Type third_3ds_otp:3ds otp; auth_url:Transaction authorization response url
tradeNo	String	false	Transaction serial num
cardNo	String	false	Bank Card ID
startTime	Long	false	Start trading time. Milliseconds timestamp
endTime	Long	false	End trading time. Millisecond timestamp

Response

Param	Type	Required	Remark
cardNo	String	true	Bank Card ID
tradeNo	String	true	Transaction serial num
originTradeNo	String	false	Origin Transaction serial num
currency	String	true	currency
amount	BigDecimal	true	amount
merchantName	String	true	Merchant Name (Transaction Scenario)
values	String	true	value. The merchant's public key is encrypted and returned, and the merchant's private key decrypt.
type	String	true	Type third_3ds_otp:3ds otp; auth_url:Transaction authorization response url
description	String	false	Transaction Description
transactionTime	Long	true	Transaction time. Millisecond timestamp
expirationTime	Long	false	Expiration time. Millisecond timestamp

Example Response

third_3ds_otp

{
    "cardNo": "1242352328671924231",
    "tradeNo": "trans1232435363435463432",
    "originTradeNo": null,
    "currency": "CNY",
    "amount": "16.96",
    "merchantName": "ULTRA MOBILE",
    "values": "ajfon34nNOIN24nafaiw4onnfn0iw32ngfn0IF0Q34NFQFOFAW", //Plain text example: 204566
    "type": "third_3ds_otp",
    "transactionTime": 1729422898000,
    "description": null
}

auth_url

{
    "cardNo": "1242352328671924231",
    "tradeNo": "trans1232435363435463432",
    "originTradeNo": null,
    "currency": "CNY",
    "amount": "16.96",
    "merchantName": "ULTRA MOBILE",
    "values": "ajfon34nNOIN24nafaiw4onnfn0iw32ngfn0IF0Q34NFQFOFAW",//Plain text example: https://www.google.com
    "type": "auth_url",
    "transactionTime": 1729422898000,
    "description": null,
    "expirationTime": 1729422899000
}