Skip to content
Languages
Servers
Mock Server

https://docs.solarisgroup.com/_mock/api-reference/digital-banking/account-management/

Operations
Operations
Operations
Operations
Operations
Operations

Create a fee collection transaction

Request

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.

Path
account_idstringrequired
Bodyapplication/jsonrequired

The content of the request.

typestringrequired

The type of fee. Note that you may only collect the types of fees that have been enabled for you.

Enum"ChargeATM""ChargeATMForeignCurrency""CashDepositRetail""CashWithdrawalRetail""ChargeCardDelivery""ChargeCard""ChargeVirtualCard""ChargeReissuePhysicalCard""ChargeAdditionalPhysicalCard""ChargeAdditionalVirtualCard"
Example: "ChargeAccountMaintenance"
amountobjectrequired

The amount of the fee transaction.

Example: {"value":499,"currency":"EUR"}
amount.​valueinteger>= 1required

The value of the fee, in Euro cents.

Example: 499
amount.​currencystringrequired

The currency of the fee. Only EUR is currently supported.

Example: "EUR"
original_transaction_idstring

Optional ID to be provided for fee types that relate to or are charged for individual transactions. In this case, you would provide the ID of the booking linked to the transaction.

initiator_referencestring

Optional reference for the fee transaction to be populated by you.

Example: "2022_08_acc_maint"
idempotency_keystring

Optional idempotency key to be used when creating the fee transaction.

Example: "653e91ae-7e93-4106-a33c-00607dae851e"
valuta_datestring

Optional valuta date provided by client. If both 'original_transaction_id' and 'valuta_date' are provided in the request payload, the provided valuta_data will be used.

Example: "2023-06-01"
application/json
{ "type": "ChargeAccountMaintenance", "amount": { "value": 499, "currency": "EUR" }, "initiator_reference": "2022_08_acc_maint", "idempotency_key": "653e91ae-7e93-4106-a33c-00607dae851e" }

Responses

The operation was successful.

Bodyapplication/json
typestring

The type of fee. Note that you may only collect the types of fees that have been enabled for you.

Example: "ChargeAccountMaintenance"
amountobject

The amount of the fee transaction.

reconciliation_idstring

An ID linking a fee transaction to an account booking for reconciliation.

Example: "938cfdf93ef54bdcbd4e955584da3bf0fct"
initiator_referencestring

Optional reference for the fee transaction to be populated by you.

Example: "2022_08_acct_maint"
original_transaction_idstring

Optional ID to be provided for fee types that relate to or are charged for individual transactions. In this case, you would provide the ID of the booking linked to the transaction.

Example: "6d4659e500ef4b10aa48d6b08d0d3e7b"
solaris_initiatedboolean

A field to indicate whether the fee transaction solaris initiated or not.

Example: false
valuta_datestring

Optional valuta date provided by client. If both 'original_transaction_id' and 'valuta_date' are provided in the request payload, the provided valuta_data will be used.

Example: "2023-06-01"
Response
application/json
{ "type": "ChargeAccountMaintenance", "amount": { "value": 499, "currency": "EUR" }, "reconciliation_id": "938cfdf93ef54bdcbd4e955584da3bf0fct", "initiator_reference": "2022_08_acct_maint", "original_transaction_id": "6d4659e500ef4b10aa48d6b08d0d3e7b", "solaris_initiated": false, "valuta_date": "2023-06-01" }

List fee transactions for an account

Request

Returns an array containing all fee transactions created for the account specified in the request URL.

Path
account_idstringrequired
Query
page[number]integer

The number of results pages to return.

page[size]string

The size of each page in the response.

filter[type]string

Filter the results by the type of fee collected.

filter[reconciliation_id]string

Filter the results by a transactions reconciliation ID. (Effectively allows you to look up the transaction of one fee booking.)

filter[solaris_initiated]boolean

Filter the results to indicate whether Solaris initiated the fee transaction.

No request payload

Responses

The operation was successful.

Headers
Totalstring

Total number of resources to return that match the provided filters.

Example: "123"
Per-Pagestring

Number of resources to return per page.

Example: "10"
Linkstring

Links to other pages.

Example: "<url?page[size]=10&page[number]=1>; rel=\"first\", <url?page[size]=10&page[number]=13>; rel=\"last\", <url?page[size]=10&page[number]=2>; rel=\"next\", <url?page[size]=10&page[number]=4>; rel=\"prev\"\n"
Bodyapplication/jsonArray [
typestring

The type of fee. Note that you may only collect the types of fees that have been enabled for you.

Example: "ChargeAccountMaintenance"
amountobject

The amount of the fee transaction.

reconciliation_idstring

An ID linking a fee transaction to an account booking for reconciliation.

Example: "938cfdf93ef54bdcbd4e955584da3bf0fct"
initiator_referencestring

Optional reference for the fee transaction to be populated by you.

Example: "2022_08_acct_maint"
original_transaction_idstring

Optional ID to be provided for fee types that relate to or are charged for individual transactions. In this case, you would provide the ID of the booking linked to the transaction.

Example: "6d4659e500ef4b10aa48d6b08d0d3e7b"
solaris_initiatedboolean

A field to indicate whether the fee transaction solaris initiated or not.

Example: false
valuta_datestring

Optional valuta date provided by client. If both 'original_transaction_id' and 'valuta_date' are provided in the request payload, the provided valuta_data will be used.

Example: "2023-06-01"
]
Response
application/json
[ { "type": "ChargeAccountMaintenance", "amount": {}, "reconciliation_id": "938cfdf93ef54bdcbd4e955584da3bf0fct", "initiator_reference": "2022_08_acct_maint", "original_transaction_id": "6d4659e500ef4b10aa48d6b08d0d3e7b", "solaris_initiated": false, "valuta_date": "2023-06-01" } ]
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations