IBAN Deconstruct

Overview

The IBAN Deconstruct feature enables the extraction of a BIC (Bank Identifier Code) from an IBAN (International Bank Account Number). This functionality is essential to the Verification of Payee process, as it determines the correct routing to the appropriate service for verifying the payee.

IBAN deconstruction is done using the CSM reachability service, detailed information on this functionality is available here

How It Works

The IBAN Deconstruct feature works as follows:

  1. The client sends a request without providing a BIC.

  2. A request is sent to the CSM Reachability Service to deconstruct the IBAN.

  3. The service returns the BIC.

  4. The BIC is used for routing to the appropriate service to perform payee verification

Integration with the IBAN Deconstruct service is handled through the Connector Framework, using an HTTP connector. More information on the HTTP connector is available here.

Configuration

The following configuration options are available for IBAN Deconstruct:

Property Grouping: ipf.csm-reachability-api.http.client

Key Description Default Value

ipf.csm-reachability-api.http.client.host

 
"localhost"

ipf.csm-reachability-api.http.client.port

 
"8080"

Property Grouping: ipf.csm-reachability-api.connector.iban-deconstruct

Key Description Default Value

ipf.csm-reachability-api.connector.iban-deconstruct.resiliency-settings.max-attempts

Determines the maximum number of retries to be made. Note that this includes the first failed attempt.

 
2

ipf.csm-reachability-api.connector.iban-deconstruct.resiliency-settings.minimum-number-of-calls

Determines the minimum number of calls (within a sliding window period) that need to be made before the circuit breaker can calculate the error rate to determine the transport health.

 
10

ipf.csm-reachability-api.connector.iban-deconstruct.resiliency-settings.retryable-status-codes

Retry if HTTP error code is in the list

 
[
    500,
    503
]

Error Handling

Runtime Errors

The following errors may occur at runtime. When an error occurs, the service responds with the corresponding HTTP error code, as outlined in the table below.

Error HTTP Return Code

When a BIC cannot be found for the provided IBAN. This can happen if the IBAN is valid but the associated financial institution does not have a BIC registered in the system. Error message: BIC not found for IBAN {iban}

400

When there’s an error from the deconstruct IBAN service. This can happen if the service returns an error response, such as a 4xx or 5xx HTTP status code. Error message: Error received from deconstruct IBAN service for IBAN {iban}

503

When the deconstruct IBAN service is unavailable. This can happen if there are network issues or if the service is down. Error message: Could not retrieve a BIC for IBAN {iban} because the deconstruct IBAN service is unavailable

503