circle-chevron-rightCards

Support Bins

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

Request

Param
Type
Require
Remark

Response

Param
Type
Required
Remark

cardTypeId

Long

true

Card type id

organization

String

true

Card organization. Visa MasterCard Discover

country

String

true

Issue country. example: US

mode

String

true

Card model. PREPAID_CARD prepaid card mode; BUDGET_CARD shared card mode

bankCardBin

String

true

Card Bin. example: 531993

type

String

true

Card type. Virtual Physical

category

String

true

Card category. GIFT PURCHASE SUBSCRIPTION PHYSICAL

cardName

String

true

Card name

cardDesc

String

true

Card desc

cardPrice

BigDecimal

true

Card fee. example: 5

cardPriceCurrency

String

true

Card fee currency. example: USD

support

List

true

Supporting merchant. For reference only

risk

List

true

High risk merchant. Consumption in this scenario will trigger card cancellation risk control

needCardHolder

Boolean

true

Cardholder is required. If it is equal to true, Need to call the [cardholder create -v2] interface and create cardholder

supportHolderRegin

List

true

Nationality. country/region code of the cardholder supported. ISO 3166-1 alpha-2

supportHolderAreaCode

List

true

Mobile area code supported by the cardholder

needDepositForActiveCard

Boolean

true

An initial deposit is required when create the card. true: Initial deposit is required. false: Initial deposit is not supported;

depositAmountMinQuotaForActiveCard

BigDecimal

true

Minimum inital deposit amount when create card

depositAmountMaxQuotaForActiveCard

BigDecimal

true

Maximum inital deposit amount when create card

fiatCurrency

String

true

Card currency. example: USD

balanceRetentionQuota

BigDecimal

true

Minimum balance to retain when calling the withdrawal API

status

String

true

Status. online offline

rechargeCurrency

String

true

Deposit currency

rechargeMinQuota

BigDecimal

true

Minimum deposit amount

rechargeMaxQuota

BigDecimal

true

Maximum deposit amount

rechargeFeeRate

BigDecimal

true

Deposit fee rate. 1=1%

rechargeFixedFee

BigDecimal

true

Fixed deposit fee

rechargeDigital

Integer

true

The length of the decimal point of the amount when deposit

enableActiveCard

Boolean

true

Enable the create card function

enableDeposit

Boolean

true

Enable the deposit card function

enableFreeze

Boolean

true

Enable the freeze card function

enableUnFreeze

Boolean

true

Enable the unfreeze card function

metadata

Object

true

Meta data

metadata.cardHolderMaxCardLimit

Integer

true

First needCardHolder equal true: Maximum number of cards a cardholder can own

metadata.cardHolderModel

String

true

Cardholder model. B2B B2C

First needCardHolder equal true: cardholder needs to be created, and different cardholder parameters need to be passed according to B2B or B2C.

call the [cardholder create -v2] interface and create cardholder The value is merely an internally defined code identifier. It has no relation to company or individual.

metadata.supportSettingNoPinPaymentAmount

Boolean

false

Set the amount limit for password-free payment (Physical card)

metadata.defaultNoPinPaymentAmount

BigDecimal

false

Default amount for password-free payment(Physical card)

metadata.noPinPaymentAmountMinQuota

BigDecimal

false

Minimum amount for password-free payment(Physical card)

metadata.noPinPaymentAmountMaxQuota

BigDecimal

false

Maximum amount for password-free payment(Physical card)

metadata.spendingControls

List

false

Spending controls

metadata.spendingControls[0].interval

String

true

Spending interval. PER_TRANSACTION

metadata.spendingControls[0].amount

BigDecimal

true

Spending amount

metadata.spendingControls[0].supportSetting

Boolean

true

Support set spending true false

metadata.supportSettingMcc

Boolean

true

Support setting allowed mcc or blocked mcc true false

Example Response

Create Card-Deprecated

circle-info

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

Request

Param
Type
Required
Remark

merchantOrderNo

String

true

Client transaction id. length[15...65]

holderId

Long

false

Cardholder id

cardTypeId

Long

true

Card type id

amount

BigDecimal

false

The deposit amount of when create the card.

If not passed, the default value is equal to depositAmountMinQuotaForActiveCard (if the card BIN requires a first deposit) Value range: /merchant/core/mcb/card/v2/cardTypes interface 1. needDepositForActiveCard = true 2. depositAmountMinQuotaForActiveCard <= amount <= depositAmountMaxQuotaForActiveCard

cardNumber

String

false

Card number. Required when create physical card

accountId

Long

false

Account ID (All payments will be deducted from this account ID; please refer to the account list interface to obtain it)

Response

Param
Type
Required
Rmark

orderNo

String

true

Transaction id

merchantOrderNo

String

true

Client transaction id

cardNo

String

false

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: Create 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

Create Card-V2

Request

Param
Type
Required
Remark

merchantOrderNo

String

true

Client transaction id. length[15...65]

holderId

Long

false

Cardholder id

cardTypeId

Long

true

Card type id

amount

BigDecimal

true

The deposit amount of when create the card. depositAmountMinQuotaForActiveCard (if the card BIN requires a first deposit) Value range: /merchant/core/mcb/card/v2/cardTypes interface 1. needDepositForActiveCard = true 2. depositAmountMinQuotaForActiveCard <= amount <= depositAmountMaxQuotaForActiveCard

cardNumber

String

false

Card number. Required when create physical card

accountId

Long

false

Account ID (In shared card mode, the default wallet account ID is not transmitted. please refer to the account list interface to obtain it)

Response

Param
Type
Required
Rmark

orderNo

String

true

Transaction id

merchantOrderNo

String

true

Client transaction id

cardNo

String

true

Card id

currency

String

true

Currency

amount

BigDecimal

true

Amount. Initial deposit amount

fee

BigDecimal

true

Fee. Initial deposit amount fee

receivedAmount

BigDecimal

false

Received Amount. Initial deposit amount

receivedCurrency

String

false

Received Currency

type

String

true

Type.

create: Create Card

status

String

true

Status. wait_process: pending; processing: processing;

success: success;

fail: failure

description

String

false

Description

remark

String

false

Remark. equal description, will remove

transactionTime

Long

true

Transaction time. Millisecond timestamp

Example Response

Card Info

Request

Param
Type
Required
Remark

cardNo

String

true

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

cardTypeId

Long

true

Card type id

cardBankBin

String

true

Bank bin

holderId

Long

false

Cardholder id

cardNo

String

true

Card id

status

String

true

Status. pending: Pending

un_activated: Waiting for activation; Normal: Normal; Freeze: Freeze; Freezing: Freezing;

UnFreezing: Unfreezing

canceling: Canceling cancel: Canceled fail: Fail. create card fail

blocked

Boolean

true

true or false. Card be blocked

bindTime

Long

true

Card create time. Millisecond timestamp

remark

String

false

Remark

balanceInfo

Object

false

Card balance information

balanceInfo.cardNo

String

true

Card id

balanceInfo.amount

BigDecimal

true

Available balance

balanceInfo.usedAmount

BigDecimal

false

Amount used. some cards bin not support

balanceInfo.currency

String

true

Currency

noPinPaymentAmount

BigDecimal

true

Physical card password-free payment amount limit

spendingControls

List

false

Spending controls

spendingControls[0].interval

String

true

Spending interval. PER_TRANSACTION

spendingControls[0].amount

BigDecimal

true

Spending amount

riskControls

Object

false

Risk controls

riskControls.allowedMcc

List

false

Allowed MCC

riskControls.blockedMcc

List

false

Blocked MCC

customCategory

String

false

Purpose

holderInfo

Object

false

Cardholder Information

holderInfo.firstName

String

false

name

holderInfo.lastName

String

false

Surname

holderInfo.country

String

false

Country

holderInfo.state

String

false

State

holderInfo.town

String

false

Town

holderInfo.address

String

false

Address

holderInfo.addressLine2

String

false

AddressLine2

holderInfo.postCode

String

false

Post Code

Example Response

Card Info For Sensitive

Request

Param
Type
Required
Remark

cardNo

String

true

Card id

Response

Param
Type
Required
Remark

cardNumber

String

true

Card number.The user's public key is encrypted and returned, and the merchant's private key is used to decrypt. Gift card not return.

cvv

String

true

CVV. The user's public key is encrypted and returned, and the merchant's private key is used to decrypt. Gift card not return.

expireDate

String

true

Expire date. The user's public key is encrypted and returned, and the merchant's private key is used to decrypt. Gift card not return.

activateUrl

String

false

Card url. The user's public key is encrypted and returned, and the merchant's private key is used to decrypt. Gift card will return.

Example Response

Card Balance

Reuqest

Param
Type
Required
Remark

cardNo

String

true

Card id

Response

Param
Type
Required
Remark

cardNo

String

true

Card id

amount

BigDecimal

true

Available balance

usedAmount

BigDecimal

true

Amount used. some cards bin not support

currency

String

true

Currency

Example Response

Card List

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

cardNo

String

false

Card id

status

String

false

Status. pending: Pending

un_activated: Waiting for activation; Normal: Normal; Freeze: Freeze; Freezing: Freezing;

UnFreezing: Unfreezing

canceling: Canceling cancel: Canceled fail: Fail. create card fail

cardTypeId

Long

false

Card type id

holderId

Long

false

Cardholder id

startTime

Long

false

Card create time. Millisecond timestamp

endTime

Long

false

Card create time. Millisecond timestamp

Response

Param
Type
Required
Remark

cardTypeId

Long

true

Card type id

cardBankBin

String

true

Bank bin

holderId

Long

false

Cardholder id

cardNo

String

true

Card id

status

String

true

Status. pending: Pending

un_activated: Waiting for activation; Normal: Normal; Freeze: Freeze; Freezing: Freezing;

UnFreezing: Unfreezing

canceling: Canceling cancel: Canceled fail: Fail. create card fail

blocked

Boolean

true

true or false. Card be blocked

bindTime

Long

true

Card create time. Millisecond timestamp

remark

String

false

Remark

balanceInfo

Object

false

Card balance information

balanceInfo.cardNo

String

true

Card id

balanceInfo.amount

BigDecimal

true

Available balance

balanceInfo.usedAmount

BigDecimal

false

Amount used. some cards bin not support

balanceInfo.currency

String

true

Currency

noPinPaymentAmount

BigDecimal

true

Physical card password-free payment amount limit

spendingControls

List

false

Spending controls

spendingControls[0].interval

String

true

Spending interval. PER_TRANSACTION

spendingControls[0].amount

BigDecimal

true

Spending amount

riskControls

Object

false

Risk controls

riskControls.allowedMcc

List

false

Allowed MCC

riskControls.blockedMcc

List

false

Blocked MCC

customCategory

String

false

Purpose

holderInfo

Object

false

Cardholder Information

holderInfo.firstName

String

false

Name

holderInfo.lastName

String

false

Surename

holderInfo.country

String

false

Country

holderInfo.state

String

false

State

holderInfo.town

String

false

Town

holderInfo.address

String

false

Address

holderInfo.addressLine2

String

false

Second row address

holderInfo.postCode

String

false

Post code

Example Response

Update Card

Webhook

Request

Param
Type
Required
Remark

cardNo

String

true

Card id

merchantOrderNo

String

true

Client transaction id. length[15...65]

clientRemark

String

false

Client remark. length[0...50]

noPinPaymentAmount

BigDecimal

false

Physical card password-free payment amount limit. 1. This parameter can be updated only when metadata.supportSettingNoPinPaymentAmount = true in the support bin interface.

2.Range: metadata.noPinPaymentAmountMinQuota <= noPinPaymentAmount <= metadata.noPinPaymentAmountMaxQuota

spendingControls

List

false

Spending controls. This parameter can be updated only when metadata.spendingControls = true in the support bin interface and only supportSetting = true

spendingControls[0].interval

String

true

Spending interval. PER_TRANSACTION

spendingControls[0].amount

BigDecimal

true

Spending amount

riskControls

Object

false

Risk controls. 1. This parameter can be updated only when metadata.supportSettingMcc = true in the support bin interface.

riskControls.allowedMcc

List

false

Allowed MCC. Specifies a whitelist of Merchant Category Codes (MCCs) that are permitted for transactions. All transactions under MCCs not listed here will be declined.

Note: Only one of allowedMcc or blockedMcc can be configured per card. If neither is provided, transactions will follow the default risk control logic. if you want to remove mcc, please Initialize an empty array

riskControls.blockedMcc

List

false

Blocked MCC. Specifies a blacklist of Merchant Category Codes (MCCs) that are restricted for transactions. Transactions under these MCCs will be declined, while all other transactions will proceed through the standard UQPAY risk control evaluation.

Note: Only one of allowedMcc or blockedMcc can be configured per card. If neither is provided, transactions will follow the default risk control logic. if you want to remove mcc, please Initialize an empty array

Response

Param
Type
Required
Remark

orderNo

String

true

Transaction id

merchantOrderNo

String

true

Client transaction id

cardNo

String

true

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. card_update: Update card

status

String

true

Status. wait_process: pending; processing: processing; success: success; fail: failure

description

String

false

Description

remark

String

false

Transaction Notes. equal description, will remove.

transactionTime

Long

true

Transaction time. Millisecond timestamp

Example Response

Update Note

Request

Param
Type
Required
Remark

cardNo

String

true

Card id

clientRemark

String

false

Client remark. length[0...50]

Response

Param
Type
Required
Remark

cardTypeId

Long

true

Card type id

cardBankBin

String

true

Bank bin

holderId

Long

false

Cardholder id

cardNo

String

true

Card id

status

String

true

Status. pending: Pending

un_activated: Waiting for activation; Normal: Normal; Freeze: Freeze; Freezing: Freezing;

UnFreezing: Unfreezing

canceling: Canceling cancel: Canceled fail: Fail. create card fail

blocked

Boolean

true

true or false. Card be blocked

bindTime

Long

true

Card create time. Millisecond timestamp

remark

String

false

Remark

balanceInfo

Object

false

Card balance information

balanceInfo.cardNo

String

true

Card id

balanceInfo.amount

BigDecimal

true

Available balance

balanceInfo.usedAmount

BigDecimal

false

Amount used. some cards bin not support

balanceInfo.currency

String

true

Currency

noPinPaymentAmount

BigDecimal

true

Physical card password-free payment amount limit

spendingControls

List

false

Spending controls

spendingControls[0].interval

String

true

Spending interval. PER_TRANSACTION

spendingControls[0].amount

BigDecimal

true

Spending amount

riskControls

Object

false

Risk controls

riskControls.allowedMcc

List

false

Allowed MCC

riskControls.blockedMcc

List

false

Blocked MCC

customCategory

String

false

Purpose

holderInfo

Object

false

Cardholder Information

holderInfo.firstName

String

false

name

holderInfo.lastName

String

false

Surname

holderInfo.country

String

false

Country

holderInfo.state

String

false

State

holderInfo.town

String

false

Town

holderInfo.address

String

false

Address

holderInfo.addressLine2

String

false

AddressLine2

holderInfo.postCode

String

false

Post Code

Example Response

Freeze Card-V2

Request

Param
Type
Required
Remark

cardNo

String

true

Card id

merchantOrderNo

String

true

Client transaction id. length[15...65]

clientRemark

String

false

Client remark. length[0...50]

Response

Param
Type
Required
Remark

orderNo

String

true

Transaction id

merchantOrderNo

String

true

Client transaction id

cardNo

String

true

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. Freeze: Freeze

status

String

true

Status. wait_process: pending; processing: processing; success: success; fail: failure

description

String

false

Description

remark

String

false

Transaction Notes. equal description, will remove.

transactionTime

Long

true

Transaction time. Millisecond timestamp

Example Response

UnFreeze Card-V2

Request

Param
Type
Required
Remark

cardNo

String

true

Card id

merchantOrderNo

String

true

Client transaction id. length[15...65]

clientRemark

String

false

Client remark. length[0...50]

Response

Param
Type
Required
Remark

orderNo

String

true

Transaction id

merchantOrderNo

String

true

Client transaction id

cardNo

String

true

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. UnFreeze: UnFreeze

status

String

true

Status. wait_process: pending; processing: processing; success: success; fail: failure

description

String

false

Description

remark

String

false

Transaction Notes. equal description, will remove.

transactionTime

Long

true

Transaction time. Millisecond timestamp

Example Response

Deposit Card

Request

Param
Type
Required
Remark

cardNo

String

true

Card ID

merchantOrderNo

String

true

Client transaction id. length[15...65]

amount

BigDecimal

true

Deposit amount

Response

Param
Type
Required
Remark

orderNo

String

true

Transaction id

merchantOrderNo

String

true

Client transaction id

cardNo

String

true

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

description

String

false

Description

remark

String

false

Transaction Notes. equal description, will remove.

transactionTime

Long

true

Transaction time. Millisecond timestamp

Example Response

Withdraw Card

Request

Param
Type
Required
Remark

cardNo

String

true

Card ID

merchantOrderNo

String

true

Client transaction id. length[15...65]

amount

BigDecimal

true

Amount. ≥ 0.01

clientRemark

String

false

Remark.[0...50] length

Response

Param
Type
Required
Remark

orderNo

String

true

Transaction id

merchantOrderNo

String

true

Client transaction id

cardNo

String

true

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.

withdraw: Withdraw

status

String

true

Status. wait_process: pending; processing: processing; success: success; fail: failure

remark

String

false

Transaction Notes. equal description, will remove.

transactionTime

Long

true

Transaction time. Millisecond timestamp

Example Response

Cancel Card

Request

Param
Type
Required
Remark

cardNo

String

true

Card ID

merchantOrderNo

String

true

Client transaction id. length[15...65]

clientRemark

String

false

Remark.[0...50] length

Response

Param
Type
Required
Remark

orderNo

String

true

Transaction id

merchantOrderNo

String

true

Client transaction id

cardNo

String

true

Card id

currency

String

true

Currency

amount

BigDecimal

true

Amount

fee

BigDecimal

true

Fee

receivedAmount

BigDecimal

false

Amount received.

receivedCurrency

String

false

The currency of the account.

type

String

true

Type.

cancel: Cancel Card

status

String

true

Status. wait_process: pending; processing: processing; success: success; fail: failure

remark

String

false

Transaction Notes. equal description, will remove.

transactionTime

Long

true

Transaction time. Millisecond timestamp

Example Response

Activate Card (physical)

Request

Param
Type
Required
Remark

merchantOrderNo

String

true

Client transaction id. length[15...65]

cardNo

String

true

Card id

pin

String

true

Card password. 6 digits, User-defined

activeCode

String

true

Activation code

noPinPaymentAmount

BigDecimal

false

The amount of payment without PIN. 0~2000USD, default 500USD

Response

Param
Type
Required
Remark

merchantOrderNo

String

true

Client transaction id

cardNo

String

true

Card id

type

String

true

Type card_activated : Activate Card

status

String

true

Status. wait_process: pending; processing: processing; success: success; fail: failure

remark

String

true

Remark

Example Response

Update PIN (physical)

Update physical card PIN

Request

Param
Type
Required
Remark

cardNo

String

true

Card id

merchantOrderNo

String

true

Client transaction id. length[15...65]

pin

String

true

PIN. 6 digits.

Rules:

  1. Must be a 6-digit number;

  2. Cannot be 3 or more consecutive repeated digits;

  3. Cannot be an entire string in ascending or descending order;

  4. Cannot be repeated two- or three-digit number segments (e.g., 123123, 909090, 121212);

Response

Param
Type
Required
Remark

orderNo

String

true

Transaction id

merchantOrderNo

String

false

Client transaction id

cardNo

String

false

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. update_pin: Update PIN

status

String

true

Status. wait_process: pending; processing: processing;

success: success;

fail: failure

description

String

false

Description

remark

String

false

Remark, equal description, will remove.

transactionTime

Long

true

Transaction time. Millisecond timestamp

响应示例

Card Purchase Transaction

Card purchase transactions. Returns records related to card fees and initial deposit amounts. This interface does not support webhooks.

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

merchantOrderNo

String

false

Client transaction id

orderNo

String

false

Transaction 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

Transaction id

merchantOrderNo

String

false

Client transaction id

cardTypeId

Long

true

Card type id

cardType

String

true

Virtual Physical

organization

String

true

Visa MasterCard Discover

bankCardBin

String

true

Card Bin. Example: 531993

currency

String

true

Currency

cardFee

BigDecimal

true

Card fee

depositAmount

BigDecimal

true

Initial deposit amount

status

String

true

Status. wait_process: pending; processing: processing;

success: success;

fail: failure

transactionTime

Long

true

Transaction time. Millisecond timestamp

Example Response

Card Operation Transaction

Webhook link

  • Type

    • blocked: The highest level of freezing. It is unilaterally initiated by the card issuing bank or card group, and can only be unfrozen through manual application.

    • overdraft_statement: Card overdraft statement. if the card balance is less than 0, it means the card is overdrawn. At this time, Wasabi will push the overdraft statement and transfer funds from the merchants's account to the Wasabi system account to make up for it. Example: when card balance equal -80USD after card be cancelled. then the transaction will be: amount = 80, and merchants's account will transfer 80USD to wasabi system account.

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: Create Card;

deposit: Deposit Card; cancel: Cancel Card; Freeze: Freeze Card; UnFreeze: UnFreeze Card; withdraw: Withdraw Card; update_pin: Update PIN blocked: Block Card card_update: Update Card overdraft_statement: Card overdraft statement.

merchantOrderNo

String

false

Client transaction id

orderNo

String

false

Transaction id

cardNo

String

false

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

Transaction id

originOrderNo

String

false

Origin Transaction order number

merchantOrderNo

String

false

Client transaction id

cardNo

String

false

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: Create Card;

deposit: Deposit Card; cancel: Cancel Card. The card cannot be reactivated; it is completely destroyed. Freeze: Freeze Card; UnFreeze: UnFreeze Card; withdraw: Withdraw Card; update_pin: Update PIN; blocked: Block Card; card_update: Update Card; overdraft_statement: Card overdraft statement.

subType

String

false

Sub type. DEFAULT: Default REFUND: Card balance refund.This generally refers to a refund initiated by the merchant after the card is cancelled. Because the card is cancelled, the balance cannot be refunded to the card itself and needs to be withdrawn to the customer's wallet.

status

String

true

Status. wait_process: pending; processing: processing;

success: success;

fail: failure

description

String

false

Description

remark

String

false

Remark, equal description. will remark

transactionTime

Long

true

Transaction time. Millisecond timestamp

Example Response

Card Operation Transaction-V2

If you create card using the /merchant/core/mcb/card/openCard interface, there will be no create record in this interface (it has been moved to the Card Purchase Transaction interface).

Webhook link

Type

  • blocked: The highest level of freezing. It is unilaterally initiated by the card issuing bank or card group, and can only be unfrozen through manual application.

  • overdraft_statement: Card overdraft statement. if the card balance is less than 0, it means the card is overdrawn. At this time, Wasabi will push the overdraft statement and transfer funds from the merchants's account to the Wasabi system account to make up for it. Example: when card balance equal -80USD after card be cancelled. then the transaction will be: amount = 80, and merchants's account will transfer 80USD to wasabi system account.

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.

create: Create Card;

deposit: Deposit Card; cancel: Cancel Card; Freeze: Freeze Card; UnFreeze: UnFreeze Card; withdraw: Withdraw Card; update_pin: Update PIN; blocked: Block Card; card_update: Update Card; overdraft_statement: Card overdraft statement.

merchantOrderNo

String

false

Client transaction id

orderNo

String

false

Transaction id

cardNo

String

false

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

Transaction id

originOrderNo

String

false

Origin Transaction No

merchantOrderNo

String

false

Client transaction id

cardNo

String

false

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: Create Card;

deposit: Deposit Card; cancel: Cancel Card; Freeze: Freeze Card; UnFreeze: UnFreeze Card; withdraw: Withdraw Card; update_pin: Update PIN; blocked: Block Card; card_update: Update Card; overdraft_statement: Card overdraft statement.

subType

String

false

Sub type. DEFAULT: Default REFUND: Card balance refund.This generally refers to a refund initiated by the merchant after the card is cancelled. Because the card is cancelled, the balance cannot be refunded to the card itself and needs to be withdrawn to the customer's wallet.

status

String

true

Status. wait_process: pending; processing: processing;

success: success;

fail: failure

description

String

false

Description

remark

String

false

Remark, equal description. will remove

transactionTime

Long

true

Transaction time. Millisecond timestamp

Example Response

Card Authorization Transaction (Consumption Bill)

Webhook link

  • Type

    • verification: Card binding verification. Example, when you bind a card to Alipay for consume, a card binding transaction record will be generated.

    • auth: Authorization (also known as consumption). such as when you subscribe to a GPT monthly membership, will generate a consumption record.

    • Void: Reversal. When user initiates a auth transaction, but a refund is issued before the acquiring bank and issuing bank have settled the transaction, this is called a reversal.

    • refund: When user initiates a auth transaction, and the acquiring bank and issuing bank have already settled the transaction, the user then initiates a refund.

    • maintain_fee: Card fee. Example monthly fee, annual fee, ATM withdraw fee...

  • Status

    • authorized: The transaction is still being processed and has not yet been settled.

    • failed: The transaction failed.

    • succeed: The transaction has been completed.

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

Transaction type of card. auth: Authorization refund: Refund verification: Verification Void: Reversal maintain_fee: Card fee (monthly fee, annual fee, ATM withdraw fee...)

tradeNo

String

false

Transaction serial number

cardNo

String

false

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

Card id

tradeNo

String

true

Transaction serial number

originTradeNo

String

false

Origin transaction serial number

currency

String

false

Currency. example: SGD

amount

BigDecimal

false

Amount. example: 125.24

authorizedAmount

BigDecimal

true

Authorized amount. example: 56

authorizedCurrency

String

true

Authorized currency. example: USD

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

authorizationCode

String

false

Authorization code

merchantName

String

false

Merchant name

merchantData

Object

false

Merchant info

merchantData.name

String

false

Merchant name

merchantData.categoryCode

String

false

Merchant Category Code (MCC)

merchantData.category

String

false

MCC category

merchantData.country

String

false

Merchant country. ISO 3166-1 alpha-2 or ISO 3166-1 alpha-3

merchantData.state

String

false

Merchant state

merchantData.city

String

false

Merchant city

merchantData.zipCode

String

false

Merchant ZIP/postal code

merchantData.mid

String

false

Merchant ID (MID)

merchantData.walletType

String

false

Digital wallet was used for the transaction

type

String

true

Transaction type of card. auth: Authorization refund: Refund verification: Verification Void: Reversal maintain_fee: Card fee (monthly fee, annual fee, ATM withdraw fee...)

status

String

true

Transaction status of card. authorized: Authorized; failed: Fail; succeed: Success

description

String

true

Transaction Description

transactionTime

Long

true

Transaction time. Millisecond timestamp

Example Response

Card Authorization Fee Transaction

Webhook link

circle-info

If the user's bank card balance is insufficient to cover the authorization fee, the bank will deducting Wasabi's funds to offset the fee. Therefore, if the user's bank card balance is insufficient, Wasabi will debit the merchant's reserve account on the platform to offset the fee.

Fee Collection Process

  1. Bank debits the card balance (deduction fails due to insufficient card balance)

  2. Bank debits Wasabi's reserve funds to offset the fee. The bill is sent to Wasabi.

  3. Wasabi verifies the card balance and debits the card balance to offset the fee (deduction fails due to insufficient card balance)

  4. Wasabi debits the merchant's reserve account on the platform to offset the fee. [A fee record will be generated after this link is executed.]

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

tradeType

String

false

Transaction type of card. card_patch_fee: Authorization fee card_patch_cross_border: Cross border fee

tradeNo

String

false

Transaction id

originTradeNo

String

false

Origin authorization Transaction serial number

cardNo

String

false

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

Card id

tradeNo

String

true

Transaction id

originTradeNo

String

true

Origin Trade No , Authorization transaction in tradeNo

currency

String

true

Fee currency. example: USD

amount

BigDecimal

true

Fee amount

type

String

true

card_patch_fee: auth fee;

card_patch_cross_border: cross-border fee;

deductionSourceFunds

String

true

Source of fund deduction. wallet: wallet. User master account

status

String

true

Status success: success

transactionTime

Long

true

Transaction time (unit: milliseconds)

Response Example

Card 3DS Transaction

Webhook link

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: otp;

auth_url:Transaction authorization response url activation_code: activation code (physical card)

tradeNo

String

false

Transaction serial number

cardNo

String

false

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

Card ID

tradeNo

String

true

Transaction serial number

originTradeNo

String

false

Origin Transaction serial number

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 activation_code: activation code (physical card)

description

String

false

Transaction Description

transactionTime

Long

true

Transaction time. Millisecond timestamp

expirationTime

Long

false

Expiration time. Millisecond timestamp

Example Response

Last updated