Card and customer limits
Raise, lower and reverse the spending limit on a card or on the customer behind it. Every change returns a log id you can reverse with.
changeCardLimitDecrease
Decreases the limit of a specified card. The method validates that the request and limit are provided, then calls the LimitService to apply the decrease. Returns log IDs for both card and customer limit changes, and LKS result if ChangeCustomerLimit is true. Handles optional parameters such as LimitRatio, CashLimitRatio, ApplicationNo, CardProfileSetCode, and SkipReverseWhenLksFailed.
Part of:
- Journey 02 · Managing a card product — step 2, Change limits
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
changeCardLimitDecrease › Request Body
channelThree-digit code identifying the channel on behalf of which the request is made (e.g. 002 for Internet). Mandatory in every request. Used for entitlement checks, limit enforcement and audit logging. Channel codes are managed through configuration parameters and may change over time. Refer to the Channels page for the current list of valid codes.
limitThe limit the card is lowered to — an absolute figure, not a difference.
shadowCardNumberOne-of — The card whose limit changes — send this or the other card identifier. Neither is validated as a field. The service's checks on them are commented out, so a request carrying neither is refused as a business failure with no card found, rather than as a missing field.
cardRefNumberOne-of — The card whose limit changes — send this or the other card identifier. Neither is validated as a field. The service's checks on them are commented out, so a request carrying neither is refused as a business failure with no card found, rather than as a missing field.
limitRatioThe limit as a share of another limit rather than an amount.
cashLimitRatioHow much of the card's limit may be drawn as cash, as a share.
changeCustomerLimitWhether the customer's limit moves with the card's.
cardProfileSetCodeWhich profile set the card's limits come from. Defined in the parameter tables.
applicationNoThe credit application the limit notification is filed under. It is forwarded to core banking, which files the notification and answers; the platform stores nothing of what is sent, so its format is the bank's rather than this API's.
Only read when the customer's limit is being lowered too, and then only for an individual product: the notification step runs under changeCustomerLimit, and a corporate product never reaches it.
Leaving it out is not the same as having none. The service falls back to the application id of the customer's current card — a supplementary one first — and files the notification under that, so omitting the field chooses a value rather than omitting one.
skipReverseWhenLksFailedWhether to leave the payment in place when the core banking leg fails rather than reversing it.
changeCardLimitDecrease › Responses
Success
listOfCardLimitChangeLogIdThe limit changes to reverse, by the log id each change returned.
listOfCustomerLimitChangeLogIdThe customer limit changes to reverse, by the log id each change returned.
changeCardLimitIncrease
Increases the limit of a specified card. The method validates that the request and limit are provided, then calls the LimitService to apply the increase. Returns log IDs for both card and customer limit changes. Supports optional parameters such as LimitRatio, CashLimitRatio, ChangeCustomerLimit, and CardProfileSetCode.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
changeCardLimitIncrease › Request Body
channelThree-digit code identifying the channel on behalf of which the request is made (e.g. 002 for Internet). Mandatory in every request. Used for entitlement checks, limit enforcement and audit logging. Channel codes are managed through configuration parameters and may change over time. Refer to the Channels page for the current list of valid codes.
limitThe limit the card is raised to — an absolute figure, not a difference. A value equal to or below the card's current limit is refused by the increase rules rather than accepted as a no-op.
shadowCardNumberOne-of — The card whose limit changes — send this or the other card identifier. Neither is validated as a field. The service's checks on them are commented out, so a request carrying neither is refused as a business failure with no card found, rather than as a missing field.
cardRefNumberOne-of — The card whose limit changes — send this or the other card identifier. Neither is validated as a field. The service's checks on them are commented out, so a request carrying neither is refused as a business failure with no card found, rather than as a missing field.
limitRatioThe limit as a share of another limit rather than an amount.
cashLimitRatioHow much of the card's limit may be drawn as cash, as a share.
changeCustomerLimitWhether the customer's limit moves with the card's.
cardProfileSetCodeWhich profile set the card's limits come from. Defined in the parameter tables.
changeCardLimitIncrease › Responses
Success
listOfCardLimitChangeLogIdThe limit changes to reverse, by the log id each change returned.
listOfCustomerLimitChangeLogIdThe customer limit changes to reverse, by the log id each change returned.
changeCardLimitReverse
Reverses previously applied card and/or customer limit changes. Takes lists of CardLimitChangeLogId and CustomerLimitChangeLogId, calls LimitService to perform the reversal, and returns any errors encountered. Logs errors if reversal fails for any entry.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
changeCardLimitReverse › Request Body
channelThree-digit code identifying the channel on behalf of which the request is made (e.g. 002 for Internet). Mandatory in every request. Used for entitlement checks, limit enforcement and audit logging. Channel codes are managed through configuration parameters and may change over time. Refer to the Channels page for the current list of valid codes.
listOfCardLimitChangeLogIdListHasNoItem — The card limit changes to undo. Each entry is one cardLimitChangeLogId — a whole number, the record id of a row in the card limit change log — and they are the ids changeCardLimitDecrease, changeCardLimitIncrease and the other limit changes hand back in their own listOfCardLimitChangeLogId. A caller does not compose one.
Mandatory: an absent list and an empty one are refused alike. An id that matches no log row stops the whole request rather than being skipped.
listOfCustomerLimitChangeLogIdThe customer limit changes to undo, in the same form: each entry is the record id of a row in the customer limit change log, as returned in listOfCustomerLimitChangeLogId. Left out or empty, no customer limit is touched and only the card limits above are reversed. An id that matches no log row stops the request.
changeCardLimitReverse › Responses
Success
listOfErrorresetCardLimit
Resets the credit limit for a specific card, based on the provided card reference number. Returns the change log record ID as confirmation of the reset action.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
resetCardLimit › Request Body
channelThree-digit code identifying the channel on behalf of which the request is made (e.g. 002 for Internet). Mandatory in every request. Used for entitlement checks, limit enforcement and audit logging. Channel codes are managed through configuration parameters and may change over time. Refer to the Channels page for the current list of valid codes.
cardRefNumberThe card whose limit is reset, by card reference number. Checked here, unlike on the increase and decrease operations, where the equivalent check is commented out.
resetCardLimit › Responses
Success
changeLogRecordIdchangeCardAutoLimitIncrease
Updates the AutoLimitIncreaseFlag for a card. Calls lifecycle service ChangeCardAutoLimitIncrease with given CardRefNumber, ShadowCardNumber, and desired AutoLimitIncreaseFlag. Returns the updated card reference, new flag value, and whether the change occurred.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
changeCardAutoLimitIncrease › Request Body
channelThree-digit code identifying the channel on behalf of which the request is made (e.g. 002 for Internet). Mandatory in every request. Used for entitlement checks, limit enforcement and audit logging. Channel codes are managed through configuration parameters and may change over time. Refer to the Channels page for the current list of valid codes.
cardRefNumberRequired in practice — The card the operation acts on. Not validated as a field — a request that names no card, or names one that does not exist, is refused as a business failure with no card found rather than as a missing field.
autoLimitIncreaseFlagWhether the card takes part in automatic limit increases.
shadowCardNumberRequired in practice — The card the operation acts on. Not validated as a field — a request that names no card, or names one that does not exist, is refused as a business failure with no card found rather than as a missing field.
changeCardAutoLimitIncrease › Responses
Success
isChangedcardRefNumberThe card reference, which identifies one issued card including its renewals. Returned by the create and listing operations alongside the shadow number.
autoLimitIncreaseFlagWhether the card takes part in automatic limit increases.
getCustomerTotalLimitInfo
Retrieves the total limit information for a customer. The method validates the request, fetches the customer master information to get the overall customer limit, and then determines the last application ID associated with a product. It identifies the physical card with the highest limit and most recent insertion date, and if none is available or the application ID is missing, it checks digital cards. The response includes the customer's total limit and the corresponding card application ID.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getCustomerTotalLimitInfo › Request Body
channelThree-digit code identifying the channel on behalf of which the request is made (e.g. 002 for Internet). Mandatory in every request. Used for entitlement checks, limit enforcement and audit logging. Channel codes are managed through configuration parameters and may change over time. Refer to the Channels page for the current list of valid codes.
customerNumberCustomer whose total limit is read. Three separate refusals — absent, zero and negative each raise their own code.
productNumberThe card product the card is issued on. Defined in the parameter tables; getCardProductList returns the ones a tenant may use.
getCustomerTotalLimitInfo › Responses
Success
customerLimitThe limit of the customer behind the card.
cardApplicationNumbergetCreditCardLimit
Retrieves credit card limit information using ShadowCardNumber. Validates the card identifier, resolves the card reference number, and fetches limit data from the limit service. Returns total card limit and available cash advance limit.
Part of:
- Journey 02 · Managing a card product — step 1, Read limits
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getCreditCardLimit › Request Body
channelThree-digit code identifying the channel on behalf of which the request is made (e.g. 002 for Internet). Mandatory in every request. Used for entitlement checks, limit enforcement and audit logging. Channel codes are managed through configuration parameters and may change over time. Refer to the Channels page for the current list of valid codes.
shadowCardNumberThe card whose limit is read. Checked by the facade, which resolves it to a card reference number before the limit service sees it - so a card that does not exist is a business failure rather than a field one. The card's status is not checked: a closed card is read like any other.
getCreditCardLimit › Responses
Success.
A card with no limit record reads as zero, not as an error. The limit service returns nothing when it finds no limit, no used limit or no calculation, and the facade coalesces that to 0 for both figures. A card whose limit is genuinely zero and a card whose limit record is missing are therefore indistinguishable in the response.
availableCashAdvanceLimittotalLimitgetCardAvailableLimit
Retrieves the available credit and cash limits for a given card, including main and supplementary card limits and usage details.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getCardAvailableLimit › Request Body
channelThree-digit code identifying the channel on behalf of which the request is made (e.g. 002 for Internet). Mandatory in every request. Used for entitlement checks, limit enforcement and audit logging. Channel codes are managed through configuration parameters and may change over time. Refer to the Channels page for the current list of valid codes.
cardRefNumberThe card reference, which identifies one issued card including its renewals. Returned by the create and listing operations alongside the shadow number.
getCardAvailableLimit › Responses
Success
availableLimitHow much of the limit is left.
customerAvailableLimitHow much of the customer's limit is left.
availableCashLimitcustomerAvailableCashLimitlimitThe limit to set.
customerLimitThe limit of the customer behind the card.
cashLimitcustomerCashLimitlimitUsedHow much of the limit has been used.
customerLimitUsedcashLimitUsedcustomerCashLimitUsedsupplementaryCardWhether this is a supplementary card rather than a main one.
mainCardAvailableLimitmainCardAvailableCashLimitmainCardLimitmainCardCashLimitmainLimitUsedmainCashLimitUsedgetCustomerAvailableLimit
Retrieves the available credit and cash limits for a customer. Uses MainCustomerNumber and Channel to call the limit service proxy and returns available cash limit, total available limit, and related usage information. All limit-related fields are populated from the service response.
Part of:
- Journey 02 · Managing a card product — step 1, Read limits
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getCustomerAvailableLimit › Request Body
channelThree-digit code identifying the channel on behalf of which the request is made (e.g. 002 for Internet). Mandatory in every request. Used for entitlement checks, limit enforcement and audit logging. Channel codes are managed through configuration parameters and may change over time. Refer to the Channels page for the current list of valid codes.
mainCustomerNumberThe main customer of a corporate relationship, as a number. The employees and supplementary holders under it carry their own customerNumber.
getCustomerAvailableLimit › Responses
Success
availableLimitHow much of the limit is left.
availableCashLimitlimitThe limit to set.
cashLimitUsedlimitUsedHow much of the limit has been used.
changeCorporateCardLimitDecrease
Decreases the limit of a corporate credit card. Calls the Limit service to reduce the card limit and optionally the customer limit. Returns lists of change log IDs for the card and customer limits.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
changeCorporateCardLimitDecrease › Request Body
channelThree-digit code identifying the channel on behalf of which the request is made (e.g. 002 for Internet). Mandatory in every request. Used for entitlement checks, limit enforcement and audit logging. Channel codes are managed through configuration parameters and may change over time. Refer to the Channels page for the current list of valid codes.
shadowCardNumberThe platform's own handle for a card, and the identifier most operations take. It is returned by every operation that creates a card and by the card listings; a caller does not compose one.
limitThe limit to set.
cardRefNumberThe card reference, which identifies one issued card including its renewals. Returned by the create and listing operations alongside the shadow number.
limitRatioThe limit as a share of another limit rather than an amount.
cashLimitRatioHow much of the card's limit may be drawn as cash, as a share.
changeCustomerLimitWhether the customer's limit moves with the card's.
cardProfileSetCodeWhich profile set the card's limits come from. Defined in the parameter tables.
applicationNoNot read by the service. The credit application a limit notification would be filed under, which this operation never files: the notification runs only for an individual product and this one refuses anything that is not corporate. The facade forwards the field and nothing behind it looks at it.
changeCardLimitDecrease is where it is read.
changeCorporateCardLimitDecrease › Responses
Success
listOfCardLimitChangeLogIdThe limit changes to reverse, by the log id each change returned.
listOfCustomerLimitChangeLogIdThe customer limit changes to reverse, by the log id each change returned.
changeCorporateCardLimitIncrease
Increases the limit of a corporate credit card. Calls the Limit service to raise the card limit and optionally the customer limit. Returns lists of change log IDs for both the card and customer limits.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
changeCorporateCardLimitIncrease › Request Body
channelThree-digit code identifying the channel on behalf of which the request is made (e.g. 002 for Internet). Mandatory in every request. Used for entitlement checks, limit enforcement and audit logging. Channel codes are managed through configuration parameters and may change over time. Refer to the Channels page for the current list of valid codes.
limitThe limit the card is raised to — an absolute figure, not a difference. This is the one field the facade checks itself: an absent value is refused with 60008 before the limit service is reached.
shadowCardNumberOne-of — The card whose limit changes — send this or the other card identifier. Neither is validated as a field. The service's checks on them are commented out, so a request carrying neither is refused as a business failure with no card found, rather than as a missing field.
cardRefNumberOne-of — The card whose limit changes — send this or the other card identifier. Neither is validated as a field. The service's checks on them are commented out, so a request carrying neither is refused as a business failure with no card found, rather than as a missing field.
limitRatioThe limit as a share of another limit rather than an amount.
cashLimitRatioHow much of the card's limit may be drawn as cash, as a share.
changeCustomerLimitDefault false — Raise the company's limit along with the card's. True returns a second list of log ids, listOfCustomerLimitChangeLogId; false leaves it empty and the card limit may then not exceed the company's.
cardProfileSetCodeThe profile set the raised limit is applied under. Forwarded to the limit service, which decides what it means; nothing in this API reads it.
changeCorporateCardLimitIncrease › Responses
Raised. The response is log ids, not limits: listOfCardLimitChangeLogId for the card and listOfCustomerLimitChangeLogId for the company, the second only where changeCustomerLimit was sent. Those ids are what changeCardLimitReverse takes to undo this.
This operation is for a corporate product only. The individual equivalent is changeCardLimitIncrease, and a card whose product segment is not corporate is refused here rather than handled.
listOfCardLimitChangeLogIdThe limit changes to reverse, by the log id each change returned.
listOfCustomerLimitChangeLogIdThe customer limit changes to reverse, by the log id each change returned.
changeIndividualCardLimit
Updates the limit for an individual credit card. Supports updating the card limit, the customer limit, and optionally increasing all main cards limit for the customer. Returns logs of card and customer limit changes.
Part of:
- Journey 02 · Managing a card product — step 2, Change limits
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
changeIndividualCardLimit › Request Body
channelThree-digit code identifying the channel on behalf of which the request is made (e.g. 002 for Internet). Mandatory in every request. Used for entitlement checks, limit enforcement and audit logging. Channel codes are managed through configuration parameters and may change over time. Refer to the Channels page for the current list of valid codes.
customerNumberThe customer at the bank's core banking system, as a number. The platform stores it rather than issuing it, so it comes from the core.
cardRefNumberThe card reference, which identifies one issued card including its renewals. Returned by the create and listing operations alongside the shadow number.
newCustomerLimitThe limit to set on the customer.
newCardLimitThe limit to set on the card.
increaseAllMainCardsLimitFlagWhether the increase applies to every main card of the customer.
changeIndividualCardLimit › Responses
Success
listOfCardLimitChangeLogIdThe limit changes to reverse, by the log id each change returned.
listOfCustomerLimitChangeLogIdThe customer limit changes to reverse, by the log id each change returned.
decreaseCustomerLimit
Decreases the credit limit of a customer. Returns the customer limit change log IDs, card limit change log IDs, and LKS transaction result.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
decreaseCustomerLimit › Request Body
channelThree-digit code identifying the channel on behalf of which the request is made (e.g. 002 for Internet). Mandatory in every request. Used for entitlement checks, limit enforcement and audit logging. Channel codes are managed through configuration parameters and may change over time. Refer to the Channels page for the current list of valid codes.
customerNumberCustomer whose limit is decreased. Negative and zero are refused separately, both with the message CustomerNumber Is Invalid. Omitting the field is the same as sending zero and arrives as the zero failure; the null check beside those two is dead.
newCustomerLimitRequired in practice — The limit to decrease to. Not validated here — the facade's null check on it cannot fail, and there is no range check, so zero passes. Whether the value is an acceptable new limit is the credit limit service's decision, and that service was not read for this path.
skipReverseWhenLksFailedDefault false — Whether to keep the decrease when the LKS call fails instead of reversing it. Null is read as false.
decreaseCustomerLimit › Responses
Success
listOfCustomerLimitChangeLogIdThe customer limit changes to reverse, by the log id each change returned.
listOfCardLimitChangeLogIdThe limit changes to reverse, by the log id each change returned.
changeVirtualCardLimit
Updates the limit of a virtual card. Supports different limit types and end-of-day flag. Returns the new limit and log IDs for the limit change.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
changeVirtualCardLimit › Request Body
channelThree-digit code identifying the channel on behalf of which the request is made (e.g. 002 for Internet). Mandatory in every request. Used for entitlement checks, limit enforcement and audit logging. Channel codes are managed through configuration parameters and may change over time. Refer to the Channels page for the current list of valid codes.
cardRefNumberRequired in practice — The virtual card whose limit is set. Not validated here — the facade forwards every field untouched, so an absent or unknown value is refused by the limit service in its own vocabulary. The card's product must be a virtual one; this operation is not a general limit change.
limitTypeRequired in practice — Whether the limit expires. A fixed limit is time-boxed and makes endOfDayFlag meaningful; anything else is open-ended. Not validated here, and the limit service refuses a value meaning none.
Values:
S— fixed — the limit stays as setH— decreasing — each transaction reduces it
Not set is N.
newDemandedAvailableLimitRequired in practice — The available limit to set. Bounded by three pools at once — the related card's available limit, the main card's and the customer's — and exceeding any one of the three refuses the request. Not validated here.
endOfDayFlagConditional — When a fixed limit ends: at the end of the day, or otherwise on the related card's next statement date. This is what makes a single-use card possible. Read only for a fixed limit.
changeVirtualCardLimit › Responses
Set. The response is the new limit and the card limit change log ids behind it.
Two things happen that no field asks for. The virtual card's used amount is cleared in both currencies as part of the change — the card starts again from the new figure. And a virtual card carries no cash advance limit: every cash figure on it is zero, and no ratio on this request changes that.
newLimitlistOfCardLimitChangeLogIdThe limit changes to reverse, by the log id each change returned.