Queries

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
`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` / `DEPOSIT`
`startTime`	Long	—	Query start time, timestamp in seconds (UTC)
`endTime`	Long	—	Query end time, timestamp in seconds (UTC)
`pageNum`	Integer	✅	Page number, minimum 1
`pageSize`	Integer	✅	Page size, range 1–100

Request Example

{
  "cardId": 100001,
  "type": "DEPOSIT",
  "pageNum": 1,
  "pageSize": 10
}

Response Parameters

Field	Type	Description
`respCode`	String	Response code
`respMsg`	String	Response message
`data`	Object	Paginated data
`data.totalRecords`	Long	Total records
`data.pageSize`	Long	Page size
`data.current`	Long	Current page (synonym of pageNum)
`data.pageNum`	Long	Current page number
`data.totalPages`	Long	Total pages
`data.records[]`	Array	Operation record list for current page
`data.records[].operateRecordId`	Long	Operation record ID
`data.records[].cardId`	Long	Card ID
`data.records[].clientRequestId`	String	Idempotent request ID
`data.records[].type`	String	Operation type
`data.records[].status`	String	Operation status (P Processing / S Success / F Failed)
`data.records[].remark`	String	Remark
`data.records[].amount`	BigDecimal	Amount
`data.records[].currency`	String	Currency
`data.records[].operateTime`	Long	Operation time, timestamp in milliseconds (UTC)
`data.records[].feeList[]`	Array	Fee detail list
`data.records[].feeList[].feeType`	String	Fee type: `CREATE` card creation fee / `DEPOSIT` deposit fee
`data.records[].feeList[].feeAmount`	BigDecimal	Fee amount
`data.records[].feeList[].feeCurrency`	String	Fee currency

Response Example

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

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
`cardId`	Long	✅	Card ID

Request Example

{
  "cardId": 100001
}

Response Parameters

Field	Type	Description
`respCode`	String	Response code
`respMsg`	String	Response message
`data`	Object	Card basic info
`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
`cardId`	Long	✅	Card ID

Request Example

{
  "cardId": 100001
}

Response Parameters

Field	Type	Description
`respCode`	String	Response code
`respMsg`	String	Response message
`data`	Object	Balance info
`data.cardId`	Long	Card ID
`data.amount`	BigDecimal	Balance amount
`data.currency`	String	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
`cardId`	Long	✅	Card ID

Request Example

{
  "cardId": 100001
}

Response Parameters

Field	Type	Description
`respCode`	String	Response code
`respMsg`	String	Response message
`data`	Object	Sensitive info
`data.cardId`	Long	Card ID
`data.cardNumber`	String	Card number
`data.cvv`	String	CVV security code
`data.expiryDate`	String	Expiry date, format `MM/YY`

Response Example

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

Management

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

Cardholders

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