External Account Representation
- 28 Apr 2022
- 1 Minute To Read
-
Print
-
DarkLight
-
PDF
External Account Representation
- Updated On 28 Apr 2022
- 1 Minute To Read
-
Print
-
DarkLight
-
PDF
The external payments (inter-bank) require Mambu EAR service to identify the related IDs.
Create mapping
Creates a link between an external account identification (IBAN or proprietary) to a Mambu Account. The currency of the association will be the one of the underlying Mambu account. If an IBAN is supposed to be a multi-currency one, this API needs to be invoked multiple times with different Mambu accounts (for the different currencies).
This step can be done at any point in time, by calling the following API:
Action: POST
Endpoint: /accounts/{accountId}/identifications
Please be Aware
There is a short delay for newly created accounts to be synced with the Payment Gateway. This means that requests to the EAR service may fail with an ACCOUNT_NOT_FOUND error if made immediately following account creation in Mambu. We recommend implementing a retry mechanism with exponential backoff and low value for maximum number of retries if such an error is received for an account which has just been created.
Request parameters
| Name | Value |
|---|---|
| mambuId *required | Account ID in Mambu |
Request headers
| Name | Value |
|---|---|
| Content Type | application/json |
| apikey | {your API key} |
Request body
{
"identification": {
"iban": "NL19RABO8998630931"
}
}
Responses
| Code | Description |
|---|---|
| 201 | Created |
| 400 | Bad request |
| 403 | Forbidden |
| 500 | Server error |
Please Note
If the IBAN account is not compliant with the IBAN rules, an error is returned.
Create mappings
Create or replace links of an external account identification (IBAN or proprietary) to a list of Mambu accounts. The currency of the association will be the one of the underlying Mambu account.
Action: PUT
Endpoint: /accounts/identifications
Request parameters
| Name | Value |
|---|---|
| mambuId *required | Mambu account ID |
Request headers
| Name | Value |
|---|---|
| Content Type | application/json |
| apikey | {your API key} |
Request body
{
"identification": {
"iban": "DE46606951125202071272"
},
"accountIds": [
"123",
"456",
"789"
]
}
Responses
| Code | Description |
|---|---|
| 201 | Created |
| 400 | Bad request |
| 403 | Forbidden |
| 500 | Server error |
Was This Article Helpful?
