Permissions and restrictions
Turn individual capabilities on and off for a card — e-commerce, international use, mail order and other miscellaneous options.
getCardPermissions
Retrieves permission restrictions for a credit card by shadow card number. Maps results from Lifecycle service to CreditCardPermissions objects including restriction codes, descriptions, permission indicators, channel, and security flags.
Part of:
- Journey 02 · Managing a card product — step 1, Read current controls
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getCardPermissions › Request Body
shadowCardNumberThe card whose permissions are read.
getCardPermissions › Responses
Success
saveCardPermissions
Saves the card permissions including restrictions, start date, end date, and transaction ID for the specified card.
Part of:
- Journey 02 · Managing a card product — step 2, Update permissions
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
saveCardPermissions › 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.
The permissions to write. Must be sent; an empty list is accepted and changes nothing.
cardRefNumberOne-of · NotNull — The card to permit or restrict. Send this or shadowCardNumber; sending neither is refused with both named.
shadowCardNumberOne-of · NotNull — The card to permit or restrict. Send this or cardRefNumber; when both are sent this one finds the card.
saveCardPermissions › Responses
Success
changedCountHow many entries actually changed. An entry already holding the value it was sent is skipped, so this can be lower than the number sent — and zero is a success.
listOfRecordIdchangeCardMiscOption
Updates miscellaneous options for a credit card or a set of cards. Sends OptionType and OptionValue along with customer/card identifiers to the Lifecycle service and returns the list of CardMiscOptionLogRecordIds created for the change.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
changeCardMiscOption › 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.
optionTypeValues:
DS— digital slip — whether the cardholder's slip is printedDC— dynamic CVV — whether the card's CVV is generated per period
optionValueValues:
HardCopy— a printed slip — the valueDStakesDigitalSlip— a digital slip — the valueDStakestrue— dynamic CVV on — the valueDCtakes, compared as this exact string
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.
mainCardRefNumberThe card reference of the main card. On a supplementary card this is the card it hangs from; on a main card it is the card's own reference.
cardRefNumberThe card reference, which identifies one issued card including its renewals. Returned by the create and listing operations alongside the shadow number.
allMainCardFlagWhether every main card of the customer is included.
allCardFlagWhether every card of the customer is included.
changeCardMiscOption › Responses
Success
listOfCardMiscOptionLogRecordIdgetCardMiscOption
Retrieves miscellaneous option settings for credit cards based on channel, option type, customer number, main card reference, individual or all card flags, and card reference. Maps results from Lifecycle service to CardMiscOptionData objects including option type, value, customer number, and card references.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getCardMiscOption › 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.
optionTypeValues:
DS— digital slip — whether the cardholder's slip is printedDC— dynamic CVV — whether the card's CVV is generated per period
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.
mainCardRefNumberThe card reference of the main card. On a supplementary card this is the card it hangs from; on a main card it is the card's own reference.
cardRefNumberThe card reference, which identifies one issued card including its renewals. Returned by the create and listing operations alongside the shadow number.
onlyMainCardFlagWhether only main cards are included.
getCardMiscOption › Responses
Success