Permissions and restrictions
Turn individual capabilities on and off for a card — e-commerce, international use, mail order and other miscellaneous options.
getCardPermissions
Retrieves the permissions set on a debit card based on ShadowCardNumber. Returns a list of DebitCardPermissions including restriction codes, descriptions, permission indicators, channel, and security flags. Uses _dbtServiceProxy.GetCardPermissions for fetching data.
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. Not validated here — unlike the credit twin, this operation checks nothing and a card it cannot find comes back as an empty list rather than an error.
getCardPermissions › Responses
Success
saveCardPermissions
Saves or updates card permissions for a specific card. Accepts card reference number, shadow card number, channel, and a list of permission items with start/end dates and restriction codes. Returns the count of changed permissions and their record IDs.
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.
listOfRecordIdsaveCardBnplPermission
Saves or updates Buy Now Pay Later (BNPL) permissions for a card. Accepts card reference number, channel, and BNPL permission details to enable or disable BNPL features on the card.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
saveCardBnplPermission › 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.
bnplFlagWhether the transaction is a buy-now-pay-later one.
saveCardBnplPermission › Responses
Success
bnplFlagWhether the transaction is a buy-now-pay-later one.
cardRefNumberThe card reference, which identifies one issued card including its renewals. Returned by the create and listing operations alongside the shadow number.
changeCardMiscOption
Changes miscellaneous options of a debit card, supporting individual or all cards for a customer, and returns the list of log record IDs.
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.
optionTypeWhich miscellaneous option is being set. The type and its value are checked together and both must resolve against the option definitions.
Values:
DS— digital slip — whether the cardholder's slip is printedDC— dynamic CVV — whether the card's CVV is generated per period
optionValueThe value the option is set to, checked against the values its type allows.
Values:
HardCopy— a printed slip — the valueDStakesDigitalSlip— a digital slip — the valueDStakestrue— dynamic CVV on — the valueDCtakes, compared as this exact string
customerNumberThe customer the change applies to. Not validated — the service's checks on this field are commented out, so a zero or absent value is not refused here.
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 options for debit cards based on filters such as OptionType, CustomerNumber, MainCardRefNumber, CardRefNumber, and flags for all main cards or all cards. Returns a list of CardMiscOptionData containing the option type, option value, customer number, main card reference, and card reference. Uses _dbtServiceProxy.GetCardMiscOption for fetching the data.
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.
optionTypeWhich miscellaneous option is read. The card identifiers beside it are not validated — naming a card that does not exist is a business failure rather than a field one.
Values:
DS— digital slip — whether the cardholder's slip is printedDC— dynamic CVV — whether the card's CVV is generated per period
customerNumberThe customer the option is read for. Not validated — the service's check on this field is commented out.
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