Account linking
Attach and detach the accounts a card draws on, and read back what a card is currently linked to.
attachCardAccount
Attaches a debit card to an account using details like IBAN, account number, branch, suffix, type, and alias. Returns the record ID of the attachment.
Part of:
- Journey 01 · Launching a new card product — step 3, Link more accounts
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
attachCardAccount › 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.
accountTypeWhat the account is to the card. A type other than main or virement takes a further check that the plain types do not.
Values:
A— main accountV— virement
accountNumberThe account being linked. Absent and zero are refused separately — zero is checked against the numeric default rather than treated as a missing value.
shadowCardNumberThe card the account is linked to.
currencyCodeThe account's currency. Demanded here where credit's equivalent operation does not ask for it at all.
fecCodeThe foreign-currency code of the account, where the card draws on one.
accountBranchIdThe branch that holds the account, as core banking numbers it.
accountSuffixThe suffix that distinguishes one account from another under the same number at core banking.
accountAliasA name for the account, shown to the cardholder where the account is listed. The platform stores it and does not interpret it.
ibanThe account's IBAN, stored alongside the account number.
accountOrderFlagWhether this account is the one drawn on first. The account listings return the stored value.
fxAutoConversionFlagWhether a transaction in another currency is converted against this account automatically.
accountOrderWhere the account sits in the card's order, which decides what is drawn on first.
attachCardAccount › Responses
Success
recordIdThe identifier of the row the operation created or acted on. Returned rather than sent in most operations that carry it.
detachCardAccount
Detach Card Account
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
detachCardAccount › 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.
recordIdThe card-to-account link being removed, by its record id. A sibling operation detaches by account number instead and takes a different request.
shadowCardNumberThe card the link belongs to. Not validated on this operation — the record id alone identifies the link. Credit's equivalent does demand it.
detachCardAccount › Responses
Success
recordIdThe identifier of the row the operation created or acted on. Returned rather than sent in most operations that carry it.
detachCardAccountByAccountNumber
Detach Card Account By Account Number
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
detachCardAccountByAccountNumber › 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.
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.
accountSuffixThe suffix that distinguishes one account from another under the same number at core banking.
detachCardAccountByAccountNumber › Responses
Success
listOfRemovedRecordIdmodifyCardAccount
Modifies an existing card account linked to a shadow card. Updates account details including alias, branch, suffix, type, IBAN, FEC code, and order flag. Returns the updated record ID.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
modifyCardAccount › 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.
recordIdWhich card-to-account link is modified, by its record id. The fields being changed — alias, order, auto-conversion — are not themselves validated.
shadowCardNumberThe card whose link is being changed.
accountTypeValues:
A— main accountV— virement
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.
accountAliasA name for the account, shown to the cardholder where the account is listed. The platform stores it and does not interpret it.
accountOrderFlagWhether this account is the one drawn on first. The account listings return the stored value.
accountOrderWhere the account sits in the card's order, which decides what is drawn on first.
fxAutoConversionFlagWhether a transaction in another currency is converted against this account automatically.
modifyCardAccount › Responses
Success
recordIdThe identifier of the row the operation created or acted on. Returned rather than sent in most operations that carry it.
listCardAccountByAccountNumber
Lists all card-linked accounts for a given account number. Returns details including account alias, branch, suffix, type, IBAN, FEC code, insert/update info, validity, and currency code.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
listCardAccountByAccountNumber › Request Body
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.
listCardAccountByAccountNumber › Responses
Success
The accounts to attach to the card as it is created. Each entry carries the account's own identifiers; attaching one later is attachCardAccount.
listCardAccountByShadowCardNumber
Lists all accounts linked to a specific shadow card number. Returns account details including alias, branch, suffix, type, IBAN, FEC code, insert/update info, validity, and currency code.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
listCardAccountByShadowCardNumber › 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.
listCardAccountByShadowCardNumber › Responses
Success
The accounts to attach to the card as it is created. Each entry carries the account's own identifiers; attaching one later is attachCardAccount.
recreateCustomerCardAccounts
Recreates all card accounts for a customer linked to a shadow card. Accepts a list of card accounts and replaces the existing ones, ensuring all accounts are valid. Used for batch updates or correcting account assignments.
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
recreateCustomerCardAccounts › 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.
The accounts to attach to the card as it is created. Each entry carries the account's own identifiers; attaching one later is attachCardAccount.
recreateCustomerCardAccounts › Responses
Success
saveCardAccountCurrencyConversion
Save Card Account Currency Conversion
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
saveCardAccountCurrencyConversion › 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.
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.
fxAutoConversionFlagWhether a transaction in another currency is converted against this account automatically.
saveCardAccountCurrencyConversion › Responses
Success
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.
fxAutoConversionFlagWhether a transaction in another currency is converted against this account automatically.
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.
getCardAccountCurrencyConversion
Get Card Account Currency Conversion
Headers
evrst-ptrnidCorrelation id for this request. Echo it in your own logs to trace the call through the platform.
getCardAccountCurrencyConversion › 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.
getCardAccountCurrencyConversion › Responses
Success
fxAutoConversionFlagWhether a transaction in another currency is converted against this account automatically.
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.