External Providers

To manage the external providers on the platform, go to the Configuration menu and click on External Providers. This section of the platform configuration allows you to create and manage your external providers.

External providers management is restricted to specific roles. If you do not have access to this part of the platform and need to manage external providers, please contact your administrator.

An external provider is a way to configure connectivity through API with an external vendor for some services. The vendor can be the client itself to connect with the internal database, of an external FX provider. These API integrations can be done during transaction processing or for some manual actions.

External Providers list

External Providers list

In the external provider's list screen, you can:

  • Filter the list to view a more restricted list of external providers or perform a search.

  • Create a new external provider. For more details on how to create a new external provider, please refer to the section: External Provider Creation.

  • Reload the table content by clicking on the Refresh button.

By selecting a specific external provider from the list, you can:

  • Display the entire history of the selected external provider. All changes made to the external provider since its creation are listed with the corresponding dates and the identity of the modifier.

  • View all external provider details.

  • Edit the information of the selected external provider.

  • Delete the selected external provider. A confirmation dialog will be displayed. This action is final, please perform it with caution.

External Provider creation

General information step

Select the organization associated with the external provider type and click on Create.

External Provider creation screen - General information step

When creating a new external provider, you need to specify all of the following general information:

  • The external provider name: the name will be provided by the IBM team, it corresponds to a specific customer integration. This field is required.

  • The network of the external provider - it can be WIRE or AFT. This field is required.

  • The description of the external provider: this field will be displayed on other screen configurations to select the external provider you want to integrate with. This field is required.

  • Select the type of external provider (Single or Composite) - this configuration is informational only.

  • Select the method of the external provider (Asynchronous or Synchronous) depending on the type of API you want to integrate with.

  • Choose the services for your external provider. This field is required.

    • Output Connectivity: the product can generate outbound files using specific integration like a customer API or custom logic.

    • Account & Liquidity validations: the product can perform account and liquidity validations during the payment processing.

    • Transaction Posting and Reverse Posting: the product can call an external system to perform posting or reverse posting actions during payment processing.

    • Request for cancellation: the product can initiate a request for cancellation through an external API.

    • FX quote, trade, and trade cancel: the product can request, validate, and cancel FX rates using external API integrations.

    • Data source: the product can retrieve transaction data from external data sources.

    • Transaction Enrichment: the product can enrich a transaction following non-standard logic.

    • Customer Information Enrichment: the product can enrich a transaction using external customer information data.

Connectivity step

External Provider creation screen - Connectivity step

An external provider integrates with an API so connectivity information is requested for the product to reach it:

  • The request and response formats: mappings between the internal model and the external API model for request and response are needed.

  • The URL to reach the API.

  • The secret related to this API like some certificates.

  • The credentials needed to authenticate into the external API.