Card Operations API

Card operation APIs including card creation, freeze/unfreeze, and deposit.

Create Card

Create a card for a specified cardholder with a designated card product and initial deposit amount.

ItemDetails
EndpointPOST /api/v1/merchant/card/createCard

Request Parameters

FieldTypeRequiredDescription

merchantNo

Long

Merchant number

clientRequestId

String(64)

Idempotent request ID, must be unique per operation

cardholderId

Long

Cardholder ID

productId

Long

Card product ID

amount

BigDecimal

Initial deposit amount, must be greater than 0

Response Parameters

FieldTypeDescription
respCodeStringResponse code
respMsgStringResponse message
data.cardIdLongNewly created card ID

Response Example

{
  "respCode": "20000",
  "respMsg": "success",
  "data": {
    "cardId": 100001
  }
}

Card Operations (Freeze / Unfreeze)

Perform status operations on a card, such as freeze or unfreeze.

ItemDetails
EndpointPOST /api/v1/merchant/card/operate

Request Parameters

FieldTypeRequiredDescription

merchantNo

Long

Merchant number

clientRequestId

String(64)

Idempotent request ID

cardId

Long

Card ID

type

String(20)

Operation type: FREEZE / UNFREEZE

Response Parameters

FieldTypeDescription
respCodeStringResponse code
respMsgStringResponse message
data.operateRecordIdLongOperation record ID

Response Example

{
  "respCode": "20000",
  "respMsg": "success",
  "data": {
    "operateRecordId": 200001
  }
}

Deposit

Deposit a specified amount to a card.

ItemDetails
EndpointPOST /api/v1/merchant/card/deposit

Request Parameters

FieldTypeRequiredDescription

merchantNo

Long

Merchant number

clientRequestId

String(64)

Idempotent request ID

cardId

Long

Card ID

amount

BigDecimal

Deposit amount, must be greater than 0

Response Parameters

FieldTypeDescription
respCodeStringResponse code
respMsgStringResponse message
data.operateRecordIdLongOperation record ID

Response Example

{
  "respCode": "20000",
  "respMsg": "success",
  "data": {
    "operateRecordId": 200002
  }
}