New entity: Card Account
With the addition of card accounts we do support multi-account setups now. Eventually card accounts are going to be used in multi-currency contexts.
Card Account Entity
Context
We've introduced a new multi-account functionality, enabling organizations to set up multiple accounts with separate billing settings tailored to their unique business needs. This feature is ideal for customers who would like to implement different billing accounts for different groups of cards, for example, for different branches of the same legal entity. This is part of our efforts to support multiple currencies. In addition to that it enables 1:n relations between your customers and the Pliant organization (id).
Hint: Within Pliant UI when the feature is activated, additional card accounts can be created via a new "Accounts" tab, and the right account selected when issuing or requesting new cards.
Changes
Additions
We added a new endpoint (including callbacks) that returns a list of all card accounts for the given organization. Each organization has at least one active card account. Card accounts get created during the onboarding process but can also be added later. If multiple card accounts are used, there is exactly one active default card account. This default card account is used if no card account is specified in the request, where card accounts can be used, like when issuing a card. Each card account has one fixed currency for settlements. This currency is used for all transactions made with cards of this card account. More details can be found in our guides section.
- New endpoint: GET /api/card-accounts
- New Callbacks:
CARD_ACCOUNT_DETAILS_CHANGED
triggered when a new card account is created or once data about an existing card account is changed/updatedCARD_ACCOUNT_BALANCE_CHANGED
CARD_ACCOUNT_LIMIT_CHANGED
Improvements
- Organization entity: Added a new array called
cardAccounts
to the response of List Organizations and Organization Details. Furthermore, its added the cardAccounts array to theorganizationUpdated
payload which is used for multiple organization related events. - Card entity: Added optional request and response parameter
cardAccountId
to Issue Card and Issue Card (Instant) endpoints. Its also present in the response of Card Details endpoints (single, batch), Replace card as well as the List Cards endpoint. - Card request entity: Added optional request parameter
cardAccountId
to Create Card Request endpoint. Its also part of the response payload of Card Request Details and List Card request endpoints. - Card limit request entity: Added cardAccountId to the response payload of Card Limit Request Details and List Card request endpoints.
- Transaction entity: Added
cardAccountId
to request and response of List of Transactions and Transaction Details endpoints. - Payment entity: Added
cardAccountId
to request and response of List of Payments and Payment Details endpoints. - Statements entity: Added
cardAccountId
to request of List of Statements and to response of Statement Details endpoints. - Accounting transactions entity: Added
cardAccountId
to request and response of List Accounting Transactions - Cashback entity: Added cardAccountId to request and response of Cashback configuration, Cashback Amounts and Cashback History.
IMPORTANT:
- All these changes are backwards compatible as the parameter is optional in most cases because every organization always has one default card account that we use when no
cardAccountId
is specified by the API consumer. - For the List endpoints that respond with an array of entities the
cardAccountId
can be used to filter the result set.