Getting Started
  • 20 Mar 2023
  • 9 Minutes To Read
  • Dark
  • PDF

Getting Started

  • Dark
  • PDF

Before you can start using the Payments API and the Mambu Payment Gateway (MPG) the following steps are required.

Mambu configuration

1. Create API consumer and key

All requests to the Payments API require an ApiKey header.

To generate an API key, you must create an API consumer that has the Manage Payments (MANAGE_PAYMENTS) permission . For steps on how to create an API consumer, see Creating API consumers and for more general information about API consumers, see API Consumers.

For more information on generating API keys, see Generating API keys.

2. Create the Mambu API user

Next, you must create a Mambu API user with appropriate permissions and access rights. This user account is used to perform withdrawal, deposit, and adjustment transactions. For more information, see Creating a User.

Assign permissions for the payments API user

You may assign permissions either directly to the user when creating or editing the user. Or you may create a role with the appropriate permissions assigned and then assign the role to the user.

We recommend assigning permissions through a role. This will allow you to apply the permissions to new API users, as well as to secure the transaction channel you will be using for SEPA payments against accidental use by other Mambu users. For more information, see Roles.

If you choose to assign permissions through a role, create a role with the appropriate permissions assigned to it. For a list of permissions, see the table below.

Please be aware

When creating your role, you must select API under Access Rights.

If you choose to assign permissions directly, you may do so while creating or editing the user in the following step.

Permission Set Permission Details Required
Deposit Accounts View Deposit Account Details Needed for retrieving Mambu account and transaction details for accounts linked to a given IBAN, for example to update refunded payments with the details of the related Mambu transaction. Yes
Deposit Accounts Make Deposit Needed to create transactions in a Mambu account when a payment has been received for which the account holder is the creditor. Yes
Deposit Accounts Make Withdrawal Needed to create transactions in a Mambu account when a payment has been received or created for which the account holder is the debtor. Yes
Deposit Accounts Make Intra-clients Transfers Needed to process transactions where funds are being transferred between two accounts held by the same customer. Yes
Deposit Accounts Make Inter-clients Transfers Needed to process transactions where funds are being transferred between two accounts held by customers at the same financial institution. Yes
Deposit Accounts Apply Deposit Account Adjustments Needed to adjust transactions in the case of recalls or reversals. Yes
Deposit Accounts Backdate Deposit Transactions Needed to apply the correct value date when a payment is received and the settlement date is in the past. Yes
Deposit Accounts Bulk Deposit Corrections Needed to apply the correct date to transactions or reverse them in certain cases. Yes
Accounting Booking Date Deposits Journal Entries Needed to apply the correct dates to journal entries when payments are received and the settlement date is in the past. Yes
Deposit Accounts Make Early Withdrawals Mandatory if you use fixed deposit accounts and want to allow customers to make SEPA payments from such an account before the end of the maturity period. No
Holds Create Holds Needed to create authorisation holds in a Mambu account when an instant payment has been received for which the account holder is the creditor, or when an instant payment has been received or created for which the account holder is the debtor. Required permission for instant payment processing. No
Holds Edit Account Holds Needed to settle or revert authorisation holds in a Mambu account. Required permission for instant payment processing. No
Holds View Account Holds Needed for retrieving authorisation holds details. Required permission for instant payment processing. No

Create the payments API user

Please be Aware

You may not assign API access rights to a user upon creation, you must assign them when editing the user. Follow all the below steps to assign appropriate access rights.

To create a Mambu API user:

  1. Go to Mambu UI > Administration > Access > Users and select Create New User.
  2. Enter all the necessary details. If you have chosen to assign permissions directly to a user (as opposed to through a role) then select them under Permissions. If you have chosen to assign permissions through a role then make sure to select it using the Role dropdown. For a list of permissions, see Permissions for payments API user. For more information on the other available fields, see Creating A User.
  3. Select Save User to create the user.
  4. Find your user in the list of users and select Actions > Edit.
  5. Under Access Rights, select API.
  6. Select Save User.
Please be Aware

If you have assigned the user access rights using a pre-defined role, the Access Rights options will be greyed out. Make sure that API has been selected in the role configuration and that Mambu has not been selected, as this user account should not be used to interact with the Mambu UI.

Editing User dialog

Please be Aware
Please provide the credentials (username and password) to the Mambu team so that they can be set up in the payments system.

3. Create the payment transaction channels

To initiate and receive incoming credit transfers, you must create a reserved transaction channel for each payment type, currency, and direction.

Transaction channels should be created using the pattern {BIC}-{PAYMENT-TYPE}-{SCHEME}-{CURRENCY-CODE}-{DIRECTION}. For example, for incoming SEPA credit transfers, the transaction channel ID might be FUBKDE71XXX-CT-SEPA-EUR-I.

Component Notes
BIC Your BIC. Please note that you must use the BIC11 format, so any BIC8 codes must be padded with three X characters, for example, for an eight character BIC of NASSDE55, you should use NASSDE55XXX when creating your transaction channels.
PAYMENT_TYPE Must be either CT for credit transfers or DD for direct debits.
SCHEME The payment scheme supported by this transaction channel must be:
  • SEPA for SEPA payments
  • ISO20022 for generic ISO payments
  • SIC for payments via the Swiss Interbank Clearing system
  • EUROSIC for Swiss Interbank Clearing system payments in Euros
  • SWIFT_MT for SWIFT payments via the European Central Bank's real-time gross settlement system
CURRENCY_CODE The three-letter, ISO 4217 currency code. For SEPA payments, must be EUR.
DIRECTION I for incoming payments and O for outgoing.
Please be aware

In the past, there was a different pattern for setting up transaction channels where the transaction channel ID for SEPA credit transfers was _payments_sepa and for direct debits it was _direct_debit_sepa.

Old transactions will continue to be associated to these transaction channels. However, for new transactions you must switch to the new ID naming pattern.

When switching over to the new ID naming pattern, we strongly recommend that you create entirely new transaction channels instead of renaming the existing _payments_sepa or _direct_debit_sepa transaction channels.

To create the payment transaction channel:

  1. Go to Mambu UI > Administration > Financial Setup > Transaction Channels > Add Channel.
  2. Enter a Channel name.
  3. Enter the Channel ID. See the table above for details on how the pattern that the ID should follow.
  4. Under Usage Rights, if you assigned permission directly to your Mambu API user in the previous step then select All Users. If you assigned permissions to your Mambu API user through a role then select the role you created in the previous step.
  5. Select Save Changes.



For more information about transaction channels, see Transaction Channels.

4. Create the suspense account

When using Anti-Money Laundering (AML) flows, you will need an additional deposit product and account to be configured with specific general ledger (GL) accounts so that suspended amounts are tracked accurately in accounting.

4.1 Create the Suspense GL Account

Add a new Liability GL Account from: Mambu UI > Accounting > Chart of Accounts > Add A New Account
Screenshot 2020-10-13 at 12.46.52

4.2 Create the Suspense Product

Add a new active Current Account (Deposit Product) from: Mambu UI > Administration > Products > Deposits > New Deposit Product.
The product must have the following Accounting Rules: at least one account of type Asset, one Expense and one Income. For help on creating a chart of accounts you can check out how to add Accounts to your Chart of Accounts.

4.3 Create a Suspense Account

Create a Deposit Account with the product defined at step 2.

4.4 Optional: Map to IBAN

If you need to initiate payments out of the suspense account, it will have to be mapped to an IBAN, using the External Account Representation API.

Mambu Payment Gateway Configuration

5. Register a user in Mambu Payment Gateway

To register a user, use the registration form, at

Your password must have at least eight characters and include at least one of the following: uppercase letter, lowercase letter, number, and a special character.

For more information about additional password settings, see Extra System Properties.

Once registered, contact the Mambu team to confirm and grant the user you created administrator permissions. You will only need to do this once. Afterwards, the newly created admin can add and approve other new users. For more information, see User Administration and Audit Trail.


Once your account has been created, you can proceed with the configuration of the Mambu Payment Gateway by accessing the Configuration menu.

6. Go through the system properties

The configuration menu item contains the system properties configuration which consists of various configuration sections. You should go through each configuration section and enter the relevant information in the fields. The table provides a list of the configuration sections along with a description of each, select the section title for more information about the settings in each section. For more information, see System Properties.

Configuration section Description
Basic Configuration Specify the BIC of your bank and the automated clearing house (ACH) as well as the ACH system.
Callout Configuration Specify the settings for the system where your payment messages will be sent.
Message Processing Configuration Configure settings related to processing payment messages.
Extra System Properties Configure a number of parameters related to security.
Incoming Direct Debit configuration Specify the maximum number of days to retry failed debit transactions before returning the direct debit transaction.
AML Configuration Configure settings related to your AML system.
SMS Configuration Set up an SMS gateway for multi-factor authentication (MFA).

Along with the system properties configuration you must also set up your schedulers configuration.

7. Set incoming and outgoing schedulers configuration

Payments are processed in bulk, according to a configurable schedule. In order to configure this schedule, go to Mambu Payment Gateway UI > Configuration > Schedulers. For more information, see Schedulers.

For each channel you use (SEPA Credit Transfers, SEPA Direct Debit, SEPA Direct Debit Business to Business etc.), you will need to set up at least two schedulers for:

  1. Incoming (to receive payment information) and
  2. Outgoing (to send payment information)

To run a scheduler, select the button in the Start/Stop column.

For some channels you will also need to create additional schedulers to process retries and returns.


Please note
More than one outgoing or incoming scheduler can be configured for a given channel. However, you cannot create schedulers with overlapping schedules.

8. Optional: Configure holidays

It is possible to define holidays that will be used to enable or disable payments on certain dates, when the local clearing house is not operating. For more information, see Holidays.


Was this article helpful?