Fee collection
Overview
The Solaris fee collection API allows you to request the collection of fees from your customers for banking services, such as account maintenance and ATM withdrawals, in a regulatory-compliant manner.
As the Bank, Solaris will collect the applicable banking service fees that you request from your customers' accounts and hold such fees in its own settlement account. Then, on a monthly basis, Solaris will transfer the sum of the collected fees to an account you own.
See the appendix below for a full list of fee types you can collect with this endpoint.
This page explains the process behind fee collection and how to implement the relevant API endpoints.
note
To collect fees not related to banking services, please consult the billing accounts guide.
Fee collection process
Here is the process for collecting banking service fees from your customers:
-
Before you can collect a fee from a customer, they must have agreed to the relevant fee types and corresponding pricing as specified in the latest version of the Solaris Terms and Conditions.
- Whenever existing fees and their related pricing change, the customer must first consent to the new Terms and Conditions before you can request the new fee amount. See the Terms and Conditions consent log guide for information on how to handle this event.
- Call the POST Create fee collection transaction endpoint to initiate the collection process for each fee that you wish to collect from each customer.
-
When the API call succeeds, Solaris will create a booking for the fee on the customer's account and store the funds in a Solaris-owned settlement account.
- See the appendix below for a list of booking types related to fee collection.
- On a monthly basis, Solaris will pay out the collected fees to an account owned by you.
attention
You must call this endpoint each time you wish to collect a fee from each customer.
Fee collection API endpoints
Implement the following API endpoints to request fee collections from your customers:
POST Create fee collection transaction
note
You may only request fee collection for fee types that Solaris has enabled for you. Contact your Partner Manager for more information about enabling different fee types.
This endpoint creates a fee transaction on the account specified in the URL. Solaris will debit the amount from the customer's account and transfer the funds to a Solaris settlement account. Each month, Solaris will pay out the amounts collected from fee transactions to your partner account.
Request URL:
POST /v1/accounts/{account_id}/transactions/fees
Request example:
{
"type": "ChargeAccountMaintenance",
"amount": {
"value": 499,
"currency": "EUR"
},
"initiator_reference": "2022_08_acc_maint",
"idempotency_key": "653e91ae-7e93-4106-a33c-00607dae851e"
}
Response example:
{
"type": "ChargeAccountMaintenance",
"amount": {
"value": 499,
"currency": "EUR"
},
"reconciliation_id": "938cfdf93ef54bdcbd4e955584da3bf0fct",
"initiator_reference": "2022_08_acc_maint",
"original_transaction_id": "6d4659e500ef4b10aa48d6b08d0d3e7b"
}
Click here to read the full API reference.
GET List fee transactions for an account
This endpoint returns an array containing all fee transactions created for the account specified in the request URL.
Request URL:
GET /v1/accounts/{account_id}/transactions/fees
Response example:
[
{
"type": "ChargeAccountMaintenance",
"amount": {
"value": 499,
"currency": "EUR"
},
"reconciliation_id": "938cfdf93ef54bdcbd4e955584da3bf0fct",
"initiator_reference": "2022_08_acct_maint",
"original_transaction_id": "6d4659e500ef4b10aa48d6b08d0d3e7b"
}
]
Click here to read the full API reference.
Appendix I: Fee collection booking types
The following booking_type
values correspond with fee collections:
booking_type value |
Definition |
---|---|
CashDepositRetail |
Fee charged for depositing cash at a retail location using Viacash. |
CashWithdrawalRetail |
Fee charged for withdrawing cash at a retail location (e.g., supermarket cash register) using Viacash. |
ChargeAccountMaintenance |
Fee charged for account maintenance. |
ChargeATM |
Fee charged for withdrawing cash from an ATM. |
ChargeATMForeignCurrency |
Fee charged for withdrawing cash in a non-Euro currency. |
ChargeCard |
Fee charged for issuing a card. |
ChargeCardDelivery |
Fee charged for card delivery. |