MPO Setup
Jump to Section
- Login in to your MPO environment Workspace. Click on the
Create
button and selectFrom file
. - Upload the JSON file with the pre-integration template. A new
ClearBank Retailers vX.X.X (YYYY-MM-DD)
folder will be available in your workspace. - Open the
Setup
process, switch toView
mode and pressNew task
. Fill in all the parameters and clickAdd task
.Alternatively, the following JSON data can be used as
Setup
. Modify it accordingly and paste into theCode editor
tab. TheSetup
process contains configuration data for two main areas: ClearBank and Mambu data.
Setup
with Supplementary Data:
{
"authorizationHeader": "ClearBank API Authorization Token -> token obtained from CB after uploading the .csr; this is used for authorising requests from MPO to CB",
"authorizationTokenAWS": "token used to authorize requests, must match the authorization value from AWS Secret Manager",
"bacsSuspenseAccount": "Bacs Suspense Account IBAN -> > displayed in ClearBank UI - Institution Accounts",
"clearBankConfigReference": "clearBank",
"clearBankTransferChannel": "CB_Transfer (Transaction Channel ID)",
"clearBankDepositChannelFPS": "MBU_Deposit_FPS (Transaction Channel ID)",
"clearBankWithdrawalChannelFPS": "CB_Withdrawal_FPS (Transaction Channel ID)",
"clearbankUrl": "https://[tenant].clearbank.co.uk",
"clientMoneyAccount": "ClearBank Client Money Account ID -> displayed in ClearBank UI URL",
"clientMoneyAccountIBAN": "ClearBank Client Money Account IBAN -> displayed in ClearBank UI",
"clearBankIBANBankCode": "Bank code from IBAN (e.g: CLRB)",
"clearbankChargesGLChannel": "GL code -> used to log JEs for ClearBank charges",
"clearBankAccountSetup": "valid values: [singleRA] OR [VA]",
"confirmationOfPayee": "true/false",
"digitalSignatureGatewayUrl": "Invoke URL from DigitalSignature API Gateway",
"hasVirtualAccountExternalID": "true/false",
"isSupplementaryDataUsed": "true", //true - enabled in CB and used in the connector
"mambuConfigReference": "mambu",
"mambuUrl": "https://[tenant].mambu.com",
"mambuUser": "Mambu username",
"mambuPassword": "Mambu password",
"mambuApiKeyEAR": "I9yhgUVKJ1iR8zUHx9AQqW56UqUIiQuT -> api key used for EAR endpoint generated from Mambu UI - API Consumers",
"mambuTransferChannel": "MBU_Transfer (Transaction Channel ID)",
"mambuWithdrawalChannelCHAPS": "MBU_Withdrawal_CHAPS (Transaction Channel ID)",
"mambuWithdrawalChannelFPS": "MBU_Withdrawal_FPS (Transaction Channel ID)",
"mambuDepositChannelCHAPS": "CB_Deposit_CHAPS (Transaction Channel ID)",
"mambuDepositChannelFPS": "CB_Deposit_FPS (Transaction Channel ID)",
"mambuWithdrawalTransactionChannelBacs": "CB_Withdrawal_BACS (Transaction Channel ID)",
"mambuDepositTransactionChannelBacs": "CB_Deposit_BACS (Transaction Channel ID)",
"mambuTransactionsCFieldSet": "_ClearBank_Transactions (Transactions Custom Field Set ID)",
"mambuCreditorIBANCFieldId": "creditorIBAN (Custom Field ID)",
"mambuCreditorNameCFieldId": "creditorName (Custom Field ID)",
"mambuDebtorIBANCFieldId": "debtorIBAN (Custom Field ID)",
"mambuDebtorNameCFieldId": "debtorName (Custom Field ID)",
"mambuPaymentReferenceCFieldId": "paymentReference (Custom Field ID)",
"mambuTransactionEndToEndIdCFieldId": "transactionEndToEndId (Custom Field ID)",
"mambuDepositAccountCFieldSet": "_ClearBank_Deposit_Accounts (Deposit Accounts Custom Field Set ID)",
"mambuVirtualAccountIdCFieldId": "virtualAccountId (Custom Field ID)",
"mambuMandatesCFieldId": "mandateId (Custom Field ID)",
"mambuTransactionStatusCFieldId": "transactionStatus (Custom Field ID)",
"mambuAccountNumberCFieldId": "accountNumber (Custom Field ID)",
"mambuIBANCFieldId":"ibanDeposit (Custom Field ID)",
"mambuSortCodeCFieldId": "sortCode (Custom Field ID)",
"mambuAssignedDepositUserCFieldId": "Mambu User Key (who receives Mambu Tasks)",
"mambuSchemeGLChannel": "GL code -> used to log JEs for ClearBank charges",
"mambuSupplementaryDataTransactionsCFieldSet": "_ClearBank_Supplementary_Data_Tr (Supplementary Transactions Custom Field Set ID)",
"mambuSupplementaryAccountNumberCFieldId": "CB_AccountNumber (Custom Field ID)",
"mambuSupplementaryBICCFieldId": "CB_BIC (Custom Field ID)",
"mapIBANviaEAR": "true/false",
"monitorOutboundTransaction": "true/false",
"monitorInboundTransaction": "true/false",
"monitorIntraBankTransferTransaction": "true/false",
"secretKey":"key used to sign the requests from MPO to AWS, must match the signatureSecretKey value from AWS Secret Manager",
"timeForStatus": "Time (in seconds) - retry mechanism for failed API Calls",
"operatingAccountIBAN": "ClearBank Operating Account IBAN -> displayed in ClearBank UI",
"operatingAccount": "ClearBank Operating Account ID -> displayed in ClearBank UI URL",
"transactionSingleAccount": "valid values [OA] or [CMA]", //required when "clearBankAccountSetup": singleRA
"CHAPSSupplementaryDataUsedFields": [
{
"targetId": "CB_BIC",
"path": "SupplementaryData[5].Value"
},
{
"targetId": "CB_AccountNumber",
"path": "SupplementaryData[4].Value"
}
],
"FPSSupplementaryDataUsedFields": [
{
"targetId": "CB_BIC",
"path": "SupplementaryData[7].Value"
},
{
"targetId": "CB_AccountNumber",
"path": "SupplementaryData[9].Value"
}
],
}
Setup
without Supplementary Data:
{
"CHAPSSupplementaryDataUsedFields": [],
"FPSSupplementaryDataUsedFields": []
}
Notes:
- To get the value of
bacsSuspenseAccount
open your ClearBank UI and check Institution - Institution Accounts. Click onBacs Suspense Account
and copy theIBAN
. - To get the value of
clientMoneyAccount
open your ClearBank UI and navigate to Institution - Institution Accounts. Click onClient Money Account 2 (Wholesale)
and copy theaccount ID
(i.e. hyc9704d-03fa-76a5-9f324-9c87966ec55e) from the URL. - To get the value of
operatingAccount
open your ClearBank UI and navigate to Institution - Institution Accounts. Click onOperating Account
and copy theaccount ID
(i.e. erc9704d-03fa-76a5-9f324-9c87966ec55e) from the URL. - To get the value of
clientMoneyAccountIBAN
open your ClearBank UI and navigate to Institution - Institution Accounts. Copy theIBAN
(i.e. GB62CLRB04061700000062). - To get the value of
operatingAccountIBAN
open your ClearBank UI and navigate to Institution - Institution Accounts. Copy theIBAN
(i.e. GB30CLRB04061700000030). - To get the value of
digitalSignatureGatewayUrl
please check theAPI Gateway for Digital Signature
section fromSetup
configurations. - When key
hasVirtualAccountExternalID
is set totrue
in the ClearBank config, an IBAN will be automatically generated by ClearBank based on the unique external identifier provided. When this key is set tofalse
an IBAN must have been previously generated. - Custom field key
mambuAssignedDepositUserCFieldId
is optional. This field is used to save the encoded key of the user that is assigned to a specific deposit account, usually the Credit Officer. When this is populated in the configuration and the notification method istask
then all Tasks created will be assigned to this user instead of the user specified in thedefaultTaskAssigneeKey
field. - When key
mapIBANviaEAR
is set tofalse
then fieldmambuApiKeyEAR
can be empty. - When key
clearBankAccountSetup
is set toVA
then fieldtransactionSingleAccount
can be empty. - When keys
monitorInboundTransaction
,monitorOutboundTransaction
,monitorIntraBankTransferTransaction
are set totrue
the transaction will be monitored and also posted to the FinCrime module. - Property
monitorOutboundTransaction
applies to Outbound and Interbank payments. - Property
clearBankAccountSetup
can have one of the following values:VA
when Virtual Account feature is used and ClearBank IBANs are linked to Mambu Deposit Account, andmonitorInboundTransaction
,monitorOutboundTransaction
,monitorIntraBankTransferTransaction
can be set ontrue
if needed since the monitorisation can be enabled.singleRA
when a single Real Account is used from ClearBank and there is no linkage to Mambu Deposit Account, andmonitorInboundTransaction
,monitorOutboundTransaction
,monitorIntraBankTransferTransaction
must be set onfalse
since the monitorisation cannot be enabled. ParametertransactionSingleAccount
is required whensingleRA
option is used and specifies which ClearBank account IBAN will be used for all the transactions:OA
- Operating Account orCMA
- Client Money Account.
- When property
confirmationOfPayee
is set tofalse
the comparison betweentransactionOwnerName
andmambuClientFullName
is skipped for Inbound payments.
- Open the
Notification Setup
process, switch toView
mode and pressNew task
. Fill in all the parameters and clickAdd task
.
- Notification via Mambu Task
Alternatively, the following JSON data can be used asNotification Setup
. Modify it accordingly and paste into theCode editor
tab.
{
"notificationConfigReference": "notification",
"notificationChannel": "task",
"webhookUrl": "",
"webhookAPIKey": "",
"zenDeskAPIKey": "",
"zenDeskGroupId": "",
"zenDeskLogin": "",
"zenDeskSubdomain": "",
"defaultTaskAssigneeKey": "6h0146096e3bce3a016e3bce3a2e0002 (Mambu User Encoded Key)",
"timeForStatus": "Time (in seconds) - retry mechanism for failed API Calls",
"cancelMandate": "true/false",
"checkPaymentScheme": "true/false",
"returnTransaction": "true/false",
"checkVirtualAccountName": "true/false",
"createMandate": "true/false",
"createDeposit": "true/false",
"createVirtualAccount": "true/false",
"disableVirtualAccount": "true/false",
"searchMandate": "true/false",
"searchDepositAndClientDetails": "true/false",
"mapIbanToDeposit": "true/false",
"removeMandate": "true/false",
"reverseWithdrawal": "true/false",
"reverseDeposit": "true/false",
"searchVirtualAccountbyIBAN": "true/false",
"searchDepositAccountbyIBAN": "true/false",
"searchVirtualAccountCF":"true/false",
"updateMandate": "true/false",
"updateCustomField": "true/false",
"updateVirtualAccountOwnerName": "true/false",
"receiveWebhook": "true/false",
"searchTransaction": "true/false",
"returnMandate": "true/false",
"addMandate": "true/false",
"copyPaymentDetails":"true/false",
"createPayment": "true/false",
"reverseManualJE": "true/false",
"storeAMLTransaction": "true/false",
"submitTransaction": "true/false"
}
Based on the selected notification method: task
, URL
, or zenDesk
the following JSON data should be filled in the above Setup
:
- Notification via Mambu Task
{
"notificationChannel": "task",
"defaultTaskAssigneeKey": "8a0146096e3bce3a016e3bce3a2e0002 (Mambu User Encoded Key)",
}
- Notification via Webhook URL
{
"notificationChannel": "URL",
"webhookUrl": "link to external notification system"
}
- Notification via ZenDesk Ticket
{
"notificationChannel": "zenDesk",
"zenDeskAPIKey": "IUbepAEuiyypiuLQOzhAQWumi8Pyww2ODVrn6Yux (ZenDesk API key)",
"zenDeskGroupId": "450002405759 (ZenDesk User Group ID)",
"zenDeskLogin": "ZenDesk Username/Email",
"zenDeskSubdomain": "clearBankMpo (ZenDesk subdomain)"
}
Notes:
- A notification is only sent if the value is set to
true
in theNotification Setup
process. - When notifications are set to
false
or are set totrue
but creation of the Mambu/Zendesk ticket fails, the responses are saved in State Diagrams in order to be analyzed.