Get Card Account Limits
GET/openapi/v2/cards/account-limits| Item | Value |
|---|---|
| HTTP method | GET |
| Request path | /openapi/v2/cards/account-limits |
| Request type | query |
Queries limits for the account associated with a card in the current tenant. These limits differ from the fund balance returned by Get Card Balance; do not add or substitute them.
Follow V2 Signing and Authentication and Common Responses. Availability depends on the card product's capabilities. Unsupported products return an error; fund balances are not used as substitute limits.
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
cardId | string | Yes | Platform card ID in the current tenant, maximum 128 characters; not a full card number. |
Supply only the card ID, not a user, tenant, or service-provider account identifier.
GET /openapi/v2/cards/account-limits?cardId=DEMO-CARD-001Response data
| Field | Type | Description |
|---|---|---|
cardId | string | Requested card ID. |
fpCardAccountId | string | Platform card account identifier; different cards in one account may return the same limits. |
currency | string | Limits currency. |
accountType | string | asset-link, fixed-limit, program-limit, or prepaid. |
totalLimit | string/null | Total account limit; may be null for prepaid. |
usedLimit | string/null | Current net utilization, not historical cumulative spending; may be null for prepaid. |
availableLimit | string | Returned available amount; do not calculate it by subtracting utilization from the total. |
All amounts are non-scientific decimal strings, not JSON numbers; trailing zeros are not guaranteed. A true zero can be "0". A null value is unavailable and must not be displayed or calculated as zero.
accountType
| Value | Meaning |
|---|---|
asset-link | Asset-linked limits. |
fixed-limit | Fixed limits. |
program-limit | Program-based limits; additional program-level restrictions may apply. |
prepaid | Prepaid mode; total limit and current net utilization may be unavailable. |
Different cards held by one user may belong to different card accounts. Identify limit ownership through fpCardAccountId, not the user alone. Refunds or repayments may change usedLimit; it is not cumulative spending.
availableLimit does not guarantee that a later payment will succeed. Card status and other product restrictions still apply.
Response Example
All data below is illustrative.
{
"code": 200,
"msg": "操作成功",
"data": {
"cardId": "DEMO-CARD-001",
"fpCardAccountId": "DEMO-CA-001",
"currency": "USD",
"accountType": "asset-link",
"totalLimit": "100",
"usedLimit": "20",
"availableLimit": "80"
}
}For prepaid, totalLimit and usedLimit may explicitly be null. availableLimit still reflects the actual query result.
Failure Handling
- A missing card, a card outside the current tenant, unsupported queries, query failures, or unconfirmed account ownership or data use the common error response. No substitute limits are returned.
- This endpoint only queries limits. It does not modify card status, account ownership, or funds.
- A failed request does not return a successful limits object in
data. Use Get User Card Overview when card lists must remain available despite an individual failure; itscardAccounts[]separately reportFAILEDorUNSUPPORTED.
