Cash advance
Draw cash against a credit line, and cancel an advance before it settles.
getCashAdvanceInfo
Provides information about a cash advance request for a given account or shadow card. Returns the authorized code, success flag, response codes, requested cash advance amount, applicable fee, interest rate, total amount, and calculated cash profit and total amount based on the current period.
Part of:
- Journey 02 · Managing a card product — step 2, Cash advance
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getCashAdvanceInfo › Request Body
channelIdThree-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.
shadowCardNumberRequired in practice — The card to quote against. Not validated here, and it is read twice over: forwarded to the authorisation service, and used to find the card's product, which is what decides the tax rates. A value that matches no card is not refused; see the 200 description.
accountNumberThe account the advance would be drawn against. Forwarded untouched; this API neither reads it nor checks it.
An account at the bank's core banking system rather than a column here, so its format is the core's: no table behind these APIs holds an account number as text, and most of this platform's own requests type it as a number. The platform stores iban and accountAlias instead, and publishes a width for both.
cashAdvanceAmountRequired in practice — The amount to quote for. Not validated here — it is forwarded to the authorisation service, and it is also the amount the taxed total below is computed from.
getCashAdvanceInfo › Responses
A quote, and two totals that are not the same number. The enquiry writes nothing. It asks the authorisation service for the fee and the interest rate, and then computes a taxed total of its own beside the one that service returned.
totalAmountis the authorisation service's figure.calculatedTotalAmountandcalculateCashProfitare computed here: interest isamount × rate × 30 ÷ (30 × 100), and the 30 is a fixed constant, not the term of anything — it is the assumption the preview is built on. Two legal taxes are added on top, each rounded to two decimals away from zero, and which rates apply is chosen by whether the card's product segment marks it commercial.
Which of the two a screen shows is a product decision somebody has to take deliberately.
A refusal arrives as a 200. isSuccess, responseCode and responseReasonCode are the authorisation service's answer and are returned as fields; an unsuccessful enquiry is not turned into an error here. And if the card cannot be read, the tax computation is skipped silently — the two computed fields come back as zeros with no error raised, so a free quote and an unknown card look identical. Confirm the card before trusting one.
isSuccessWhether the operation did what it was asked to. A false here arrives with HTTP 200, so it has to be read rather than inferred from the status.
cashAdvanceFeeAmountcashAdvanceInterestRatecashAdvanceAmountThe amount to draw as cash.
totalAmountThe amount of every entry in the list added together.
calculateCashProfitcalculatedTotalAmountauthCodeThe authorisation code the issuer returned when the transaction was approved. Six characters, from the scheme.
responseCodeThe downstream system's own result code, passed through. 00 and 0 are success; anything else is its refusal, and responseReasonCode or the description says which.
responseReasonCodeWhy the downstream system answered as it did, where it narrows the response code.
doCashAdvance
Performs a cash advance for the given account and shadow card. Returns authorization code, response codes, transaction ID, fee, and RRN. Throws exception if the transaction fails.
Part of:
- Journey 02 · Managing a card product — step 2, Cash advance
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
doCashAdvance › Request Body
channelIdThree-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.
accountNumberThe account at the bank's core banking system that the card draws on. It must already exist, belong to the card's customer, and be neither shared nor a foreign-currency account.
An account at the bank's core banking system rather than a column here, so its format is the core's: no table behind these APIs holds an account number as text, and most of this platform's own requests type it as a number. The platform stores iban and accountAlias instead, and publishes a width for both.
referenceNumberThe caller's own reference for the withdrawal, forwarded to the authorisation service. It is the value reverseCashAdvance takes to undo this one.
cashAdvanceAmountRequired in practice — The amount to withdraw. Not validated here; forwarded unchanged. No quote has to have been taken first and nothing here compares the two.
doCashAdvance › Responses
Taken. Unlike the enquiry, an unsuccessful answer here is raised rather than reported: the facade checks the authorisation service's isSuccess and turns a false into a business failure.
That failure carries a code from no catalogue on this portal. The errorCode in the 400 body is the authorisation service's own responseReasonCode, passed through verbatim, and the message is its own description. So a client cannot branch on a known numbered code for this operation — the reason text and that service's code list are what there is.
The transaction date is this service's clock. There is no date field and a withdrawal cannot be backdated.
isSuccessWhether the operation did what it was asked to. A false here arrives with HTTP 200, so it has to be read rather than inferred from the status.
feeAmountThe fee charged on the transaction.
uTIDThe unique transaction identifier the platform gives a transaction, and the handle every later operation on it takes. Returned by the transaction listings.
authCodeThe authorisation code the issuer returned when the transaction was approved. Six characters, from the scheme.
responseCodeThe downstream system's own result code, passed through. 00 and 0 are success; anything else is its refusal, and responseReasonCode or the description says which.
responseReasonCodeWhy the downstream system answered as it did, where it narrows the response code.
rrnThe retrieval reference number — the card scheme's handle for the transaction, and what a bank quotes when asking the scheme about it.
reverseCashAdvance
Reverses a cash advance transaction by using the provided reference number, amount, shadow card number, and UTID.
Part of:
- Journey 02 · Managing a card product — step 4, Reversals
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
reverseCashAdvance › Request Body
amountThe amount.
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.
uTIDThe unique transaction identifier the platform gives a transaction, and the handle every later operation on it takes. Returned by the transaction listings.
referenceNumberThe caller's own reference for the transaction, carried into the institution transaction record. It is truncated to 50 characters rather than refused.
reverseCashAdvance › Responses
Success
isSuccessWhether the operation did what it was asked to. A false here arrives with HTTP 200, so it has to be read rather than inferred from the status.
uTIDThe unique transaction identifier the platform gives a transaction, and the handle every later operation on it takes. Returned by the transaction listings.
authCodeThe authorisation code the issuer returned when the transaction was approved. Six characters, from the scheme.
responseReasonCodeWhy the downstream system answered as it did, where it narrows the response code.
getCancelableCashAdvanceList
Retrieves a list of cancellable cash advances for a given shadow card number, including transaction details and card master information.
Part of:
- Journey 02 · Managing a card product — step 2, Cash advance
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getCancelableCashAdvanceList › Request Body
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.
getCancelableCashAdvanceList › Responses
Success