Card Query API

Card query APIs including operation records, basic info, balance, and sensitive information.

Query Card Operation Records

Query card operation records with pagination, filterable by card ID and operation type.

Item	Details
Endpoint	`POST /api/v1/merchant/card/getOperateRecordList`

Request Parameters

Field	Type	Required	Description
`merchantNo`	Long	✅	Merchant number
`cardId`	Long	—	Card ID, queries all merchant cards if omitted
`clientRequestId`	String(64)	—	Idempotent request ID for filtering
`type`	String(20)	—	Operation type: `CREATE` / `FREEZE` / `UNFREEZE` / `TERMINATE` / `DEPOSIT` / `WITHDRAW`
`startTime`	Long	—	Query start time, timestamp in milliseconds (UTC)
`endTime`	Long	—	Query end time, timestamp in milliseconds (UTC)
`pageNum`	Integer	✅	Page number, minimum 1
`pageSize`	Integer	✅	Page size, range 1–100

Response Parameters

Field	Type	Description
`data.records[]`	Array	Operation record list
`records[].operateRecordId`	Long	Operation record ID
`records[].cardId`	Long	Card ID
`records[].clientRequestId`	String	Idempotent request ID
`records[].type`	String	Operation type
`records[].status`	String	Status: `P` Processing / `S` Success / `F` Failed
`records[].amount`	BigDecimal	Amount
`records[].currency`	String	Currency
`records[].operateTime`	Long	Operation time, timestamp in milliseconds (UTC)
`records[].feeList[]`	Array	Fee detail list
`feeList[].feeType`	String	Fee type: `CREATE` / `DEPOSIT`
`feeList[].feeAmount`	BigDecimal	Fee amount
`feeList[].feeCurrency`	String	Fee currency
`data.total`	Long	Total records
`data.current`	Long	Current page
`data.size`	Long	Page size

Response Example

{
  "respCode": "20000",
  "respMsg": "success",
  "data": {
    "records": [
      {
        "operateRecordId": 200001,
        "cardId": 100001,
        "clientRequestId": "REQ_20260101_001",
        "type": "DEPOSIT",
        "status": "SUCCESS",
        "remark": null,
        "amount": 100.00,
        "currency": "USD",
        "operateTime": 1735689600000,
        "feeList": [
          { "feeType": "SETUP_FEE", "feeAmount": 1.00, "feeCurrency": "USD" }
        ]
      }
    ],
    "total": 1,
    "current": 1,
    "size": 10
  }
}

Get Card Basic Info

Query basic status information of a card.

Item	Details
Endpoint	`POST /api/v1/merchant/card/getBasicInfo`

Request Parameters

Field	Type	Required	Description
`merchantNo`	Long	✅	Merchant number
`cardId`	Long	✅	Card ID

Response Parameters

Field	Type	Description
`data.cardId`	Long	Card ID
`data.cardholderId`	Long	Cardholder ID
`data.productId`	Long	Card product ID
`data.status`	String	Card status: `PROCESSING` Creating `INFO_REQUIRED` Pending info `FAILED` Creation failed `ACTIVE` Active `FREEZING` Freezing `FROZEN` Frozen `SYSTEM_FROZEN` System frozen `UNFREEZING` Unfreezing `EXPIRED` Expired
`data.blockedFlag`	Boolean	Whether the card is blocked

Response Example

{
  "respCode": "20000",
  "respMsg": "success",
  "data": {
    "cardId": 100001,
    "cardholderId": 300001,
    "productId": 1,
    "status": "ACTIVE",
    "blockedFlag": false
  }
}

Get Card Balance

Query the current balance of a card.

Item	Details
Endpoint	`POST /api/v1/merchant/card/getBalanceInfo`

Request Parameters

Field	Type	Required	Description
`merchantNo`	Long	✅	Merchant number
`cardId`	Long	✅	Card ID

Response Parameters

Field	Type	Description
`data.cardId`	Long	Card ID
`data.amount`	BigDecimal	Current balance
`data.currency`	String	Balance currency

Response Example

{
  "respCode": "20000",
  "respMsg": "success",
  "data": {
    "cardId": 100001,
    "amount": 980.00,
    "currency": "USD"
  }
}

Get Card Sensitive Info

Query card number, CVV, expiry date, and other sensitive information.

Item	Details
Endpoint	`POST /api/v1/merchant/card/getSensitiveInfo`

This endpoint returns sensitive data. Ensure the calling environment is secure and avoid calling directly from client-side applications.

Request Parameters

Field	Type	Required	Description
`merchantNo`	Long	✅	Merchant number
`cardId`	Long	✅	Card ID

Response Parameters

Field	Type	Description
`data.cardId`	Long	Card ID
`data.cardNumber`	String	Card number (masked or full, depending on configuration)
`data.cvv`	String	CVV security code
`data.expiryTime`	String	Expiry date, format `MM/YY`

Response Example

{
  "respCode": "20000",
  "respMsg": "success",
  "data": {
    "cardId": 100001,
    "cardNumber": "4111111111111111",
    "cvv": "123",
    "expiryTime": "12/28"
  }
}

Card Operations API

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

Cardholder API

Cardholder management APIs including creation, update, and query operations.