Direct debit

Synchronizing mandates via Admin Panel

You can synchronize existing mandates with the Crassula direct debit feature directly via Admin Panel by selecting a corresponding account.

To synchronize existing mandates with Crassula, perform the steps below:

1. In the Admin Panel, navigate to Banking > Accounts on the left sidebar;

2. Choose an account for synchronizing direct debit mandates with Crassula;

3. Click the Sync mandates button in the Action column of the selected account.

The Sync mandates button in the Admin panel is available for the clients with Railsr and ClearBank providers.

Please note that funds are debited even if you don't use the Sync mandates button. This is because the functionality operates on the provider's side, not on Crassula's.

Consider using the Sync mandates button to:

• View the complete list of mandates;

• Decline a mandate.

You don't need to use the button often, as it doesn't influence the feature's main function.

After syncing mandates, check your account logs to see the updated status.

As a result, the corresponding subscriptions are added to the list of Crassula direct debits under the Banking > Direct Debit Mandates section of the Admin Panel.

Managing mandates in Web and Mobile Interfaces

Both interfaces provide the following capabilities:

• View existing direct debits: Users can scroll through a list of all active direct debit mandates that have been successfully set up.

• Transaction history: For each direct debit, users can view the history of transactions, including the amount, due date, paid date, and reference number.

• Cancel future payments: Users have the option to cancel future payments for any direct debit mandate directly from the interface.

Please note that the direct debit functionality is managed through the configuration file, where it can be enabled or disabled for both the Admin panel and the Web and Mobile Interfaces. For configuration details, contact your manager.

Accessing existing direct debits

Once the functionality is enabled and the direct debit mandates are synchronized with Crassula, navigate to either Payments & transfers > Direct Debits (under the More options button) in Web Interface or to the Planned tab in Mobile Interface. The Web Interface provides a comprehensive table with all current direct debit mandates, while the Mobile Interface displays not only direct debit items under the Planned tab but also drafts, scheduled, recurring, and other preplanned payments.

Operation statuses

Each direct debit mandate can be in one of the following three operation statuses:

• Active (green tick): The mandate is fully active and functional.

• Pending (gray clock): The mandate is undergoing initialization, registration, or awaiting confirmation. It might also be in a transitional state such as waiting for cancellation or an unknown status.

• Inactive (red cross): The mandate has been terminated due to cancellation, rejection, completion, or return.

Accessing transaction history

To access the transaction history of a single direct debit mandate, follow these steps based on your interface:

Web Interface:

1. Navigate to Payments & Transfers > Direct Debits (under the More options button).

2. Locate the direct debit mandate you wish to review in the table.

3. Click the Details button next to the mandate.

4. A dialog with all related details will appear, including a See payment history button.

5. Click the See payment history button to be redirected to the transaction history page.

Mobile Interface:

1. Navigate to the Planned tab.

2. Find and tap the direct debit item you wish to review.

3. A dialog with all related details will appear, including a View transactions button.

4. Tap the View transactions button to be redirected to the transaction history page.

Canceling future payments

To cancel future payments for a direct debit mandate, follow these steps based on your interface:

Web Interface:

1. Navigate to Payments & Transfers > Direct Debits (under the More options button).

2. Locate the direct debit mandate you wish to manage in the table.

3. Click the Details button next to the mandate.

4. A dialog with all related details will appear, including a Cancel future payments button.

5. Click the Cancel future payments button.

6. Another dialog will open, prompting you to confirm that you want to cancel future payments.

7. Confirm the cancellation.

8. A final dialog will appear, indicating that the cancellation request was successful.

Mobile Interface:

1. Navigate to the Planned tab.

2. Find and tap on the direct debit item you wish to manage.

3. A dialog with all related details will appear, including a Cancel future payments button.

4. Click the Cancel future payments button.

5. A dialog will open, prompting you to confirm that you want to cancel future payments.

6. Confirm the cancellation.

Managing mandates programmatically

This section provides general instructions on how to use the Crassula API and CLI commands to manage your direct debit mandates.

The following instructions for the accounts with the ClearBank provider outline a generic workflow, covering the main operations involved in managing direct debit mandates. This aims to provide you with a general understanding of the implemented functionality. As we continue to develop this feature, you can expect more specific examples and more advanced functionalities.

Creating a direct debit mandate

Before you start, make sure that you have an account with the ClearBank provider in real GBP.

To create a direct debit mandate on the Clearbank side, run the following command:

./run bin/console rbk-payments-data:handle-clearbank-mandates create {accountId}

• Replace {accountId} with the account number of the newly created account. Please note, this step only creates a mandate on the ClearBank side, not in Crassula.

• To view the newly created mandates, you can either run the command below or synchronize the mandates in the Admin Panel.

Synchronizing account mandates

To synchronize the account mandates on ClearBank side and in Crassula, run the following command:

./run bin/console rbk-payments-data:handle-clearbank-mandates list {accountId}

Replace {accountId} with your account number.

Alternatively, you can achieve the same effect by making the following GET API call:

GET /api/clients/{clientId}/accounts/{accountId}/direct-debit-mandates

Cancelling a direct debit mandate

To cancel a mandate, make a POST call to the following endpoint:

POST /api/clients/{clientId}/direct-debit-mandates/{directDebitMandateId}/cancel

The mandate status will change to Waiting For Cancel.

To check if the mandate is cancelled on the ClearBank side, you can use one of the following methods:

• Synchronize from the Admin Panel and view the list of direct debit mandates;

• Perform an API call or run the command from this step;

• Or, use the command below:

  CODE

  rbk-payments-data:process-cancelled-mandates

  This command checks if the mandate in status Waiting For Cancel is cancelled on the ClearBank side.