Skip to content

IFS Connect for Integrating Payments with Kyriba REST Endpoints

The purpose with this page is to provide a guide on how to configure IFS Connect for integrating outbound and inbound payments with Kyriba REST endpoints.

Kyriba is a treasury management system which acts as an intermediary facilitating the transfer of ISO20022 file and CAMT file in between IFS ERP and Banks. Kyriba provides REST endpoints to be accessed by IFS connect to provide these services.

ISO20022 XML file Outbound integrations

In this integration Kyriba provides two REST endpoints which is accessed by IFS to Upload the ISO20022 XML file to Kyriba and execute a task to transfer the file to a specific bank.

Example connect configuration for Uploading ISO20022 XML file to Kyriba.

  • Routing Rule: Example_Upload_ISO20022_Kyriba_File
  • Routing Address: Example_Upload_ISO20022_Kyriba_File

Fill the values properly in the example files as below as the first step to make the integration works.

Configure Routing Address
  1. Navigate to Routing Addresses.
  2. Transport connector should be REST.
  3. Transformer must be added according to the requirement by the customer. This is mandatory (Example- If the customer needs Core XML file IFS_ISO20022_TO_CORE_ISO20022 transformer should be set)
  4. Go to REST Address Data and fill the information as follows.
Configure Routing Rule
  1. Navigate to Routing Rules.
  2. Routing rule directions should be Outbound.
  3. Select APPLICATION_MESSAGE as Route From and ensure the Enable is selected.
  4. Enter a proper description in the Rule Name.
  5. Do not set a queue and select Finish.
  6. Navigate to group Content Based Conditions and add new. Add a condition as follows.
  7. MESSAGE_FUNCTION as Search, '=' as Operation and KYRIBA_UPLOAD as Match.
  8. Navigate to group Destination Addresses and select Set Destination Addresses.
  9. Search for the Routing Address created above and select it.

Example connect configuration for Executing a task to transfer ISO20022 XML file to bank.

Kyriba uses specific process templates which executed via task for the processing. For the transfer of XML file to the bank this task should be executed via a REST end point.

  • Routing Rule: Example_Execute_ISO20022_Kyriba_Task

  • Routing Address: Example_Execute_ISO20022_Kyriba_Task

Configure Routing Address
  1. Navigate to Routing Addresses.
  2. Transport connector should be REST.
  3. Go to REST Address Data and fill the information as follows.
  4. Rest Root End Point: Provide the REST end point URL for the for exporting data through process template API service. (Example https://www.example.com/gateway/api/v1/process-templates/ERP_ROUT_API/run)
  5. Use specific process template provided by Kyriba in the ERP_ROUT_API section on the URL.
  6. Client Id: The client identifier issued by Kyriba.
  7. Client Secret: The client secret issued by Kyriba.
  8. Token Endpoint: Provide the endpoint URL for authorization server. (Example https://www.example.com/gateway/oauth/token)
  9. Rest Http Method should be POST.
Configure Routing Rule
  1. Navigate to Routing Rules.
  2. Routing rule directions should be Outbound.
  3. Select APPLICATION_MESSAGE as Route From and ensure the Enable is selected.
  4. Enter a proper description in the Rule Name.
  5. Do not set a queue and select Finish.
  6. Navigate to group Content Based Conditions and add new. Add a condition as follows.
  7. MESSAGE_FUNCTION as Search, '=' as Operation and KYRIBA_TASK as Match.
  8. Navigate to group Destination Addresses and select Set Destination Addresses.
  9. Search for the Routing Address created above and select it.

Example connect configuration for receiving the transfer status ISO20022 XML file sent to Kyriba.

Kyriba provide specific REST end point to get the transfer status of the ISO20022 XML file which is integrated.

  • Routing Rule: Example_Get_ISO20022_Kyriba_Status

  • Routing Address: Example_Get_ISO20022_Kyriba_Status

Configure Routing Address
  1. Navigate to Routing Addresses.
  2. Transport connector should be REST.
  3. Go to REST Address Data and fill the information as follows.
  4. Rest Root End Point: Provide the REST end point URL for the receiving status of payment file API service. (Example https://www.example.com/gateway/api/v1/payment/payment-files)
  5. Client Id: The client identifier issued by Kyriba.
  6. Client Secret: The client secret issued by Kyriba.
  7. Token Endpoint: Provide the endpoint URL for authorization server. (Example https://www.example.com/gateway/oauth/token)
  8. Rest Http Method should be GET.
Configure Routing Rule
  1. Navigate to Routing Rules.
  2. Routing rule directions should be Outbound.
  3. Select APPLICATION_MESSAGE as Route From and ensure the Enable is selected.
  4. Enter a proper description in the Rule Name.
  5. Do not set a queue and select Finish.
  6. Navigate to group Content Based Conditions and add new. Add a condition as follows.
  7. MESSAGE_FUNCTION as Search, '=' as Operation and KYRIBA_STATUS as Match.
  8. Navigate to group Destination Addresses and select Set Destination Addresses.
  9. Search for the Routing Address created above and select it.

CAMT file Inbound integrations

CAMT053 and CAMT054 bank statements will be loaded to the IFS application from Kyriba via two separate database schedule tasks.

  • Import Kyriba CAMT53 File
  • Import Kyriba CAMT54 File

For the import of each CAMT file from Kyriba two REST endpoints need to be executed from IFS application to pull the CAMT file from Kyriba. For the execution of above, two sets of routing rules and addresses are used.

  • Execution of task in Kyriba with a specific process template to initiate the pulling of CAMT file.
  • Import of the CAMT file using the executed task.

CAMT053

Example connect configuration for execution of task in Kyriba with a specific process template to initiate the pulling of CAMT053 file.

  • Routing Rule: Example_Execute_CAMT_053_Kyriba_Task
  • Routing Address: Example_Execute_CAMT_053_Kyriba_Task
Configure Routing Address
  1. Navigate to Routing Addresses.
  2. Transport connector should be REST.
  3. Go to REST Address Data and fill the information as follows.
  4. Rest Root End Point: Provide the REST end point URL for executing a task to import data through process template API service. (Example https://www.example.com/gateway/api/v1/process-templates/E_AGG_CAMT-CAMT/run)
  5. Use specific process template provided by Kyriba for CAMT053 in the E_AGG_CAMT-CAMT section on the URL.
  6. Client Id: The client identifier issued by Kyriba.
  7. Client Secret: The client secret issued by Kyriba.
  8. Token Endpoint: Provide the endpoint URL for authorization server. (Example https://www.example.com/gateway/oauth/token)
  9. Rest Http Method should be POST.
Configure Routing Rule
  1. Navigate to Routing Rules.
  2. Routing rule directions should be Outbound.
  3. Select APPLICATION_MESSAGE as Route From and ensure the Enable is selected.
  4. Enter a proper description in the Rule Name.
  5. Do not set a queue and select Finish.
  6. Navigate to group Content Based Conditions and add new. Add a condition as follows.
  7. MESSAGE_FUNCTION as Search, '=' as Operation and KYRIBA_CAMT53_TASK as Match.
  8. Navigate to group Destination Addresses and select Set Destination Addresses.
  9. Search for the Routing Address created above and select it.

Example connect configuration check for executed task status of the CAMT053 file.

  • Routing Rule: Example_Get_CAMT_053_Kyriba_Task_Status

  • Routing Address: Example_Get_CAMT_053_Kyriba_Task_Status

##### Configure Routing Address

  1. Navigate to Routing Addresses.
  2. Transport connector should be REST.
  3. Go to REST Address Data and fill the information as follows.

##### Configure Routing Rule

1.  Navigate to Routing Rules.
2.  Routing rule directions should be Outbound.
3.  Select **APPLICATION_MESSAGE** as Route From and ensure the Enable is selected.
4.  Enter a proper description in the Rule Name.
5.  Navigate to group Content Based Conditions and add new. Add a condition as follows.
6.  **MESSAGE_FUNCTION** as Search, **'='** as Operation and **KYRIBA_CAMT53_GET_STATUS** as Match.
7.  Navigate to group Destination Addresses and select Set Destination Addresses.
8.  Search for the Routing Address created above and select it.

Example connect configuration import of the CAMT053 file using the executed task.

  • Routing Rule: Example_Import_CAMT_053_Kyriba_File

  • Routing Address: Example_Import_CAMT_053_Kyriba_File

Configure Routing Address
  1. Navigate to Routing Addresses.
  2. Transport connector should be REST.
  3. Go to REST Address Data and fill the information as follows.
  4. Rest Root End Point: Provide the REST end point URL for importing data through process template API service. (Example https://www.example.com/gateway/api/v1/process-templates/E_AGG_CAMT-CAMT/files)
  5. Use specific process template provided by Kyriba for CAMT053 in the E_AGG_CAMT-CAMT section on the URL.
  6. Client Id: The client identifier issued by Kyriba.
  7. Client Secret: The client secret issued by Kyriba.
  8. Token Endpoint: Provide the endpoint URL for authorization server. (Example https://www.example.com/gateway/oauth/token)
  9. Rest Http Method should be GET.
Configure Routing Rule
  1. Navigate to Routing Rules.
  2. Routing rule directions should be Outbound.
  3. Select APPLICATION_MESSAGE as Route From and ensure the Enable is selected.
  4. Enter a proper description in the Rule Name.
  5. Set the queue as OUT1 and select Finish.
  6. Navigate to group Content Based Conditions and add new. Add a condition as follows.
  7. MESSAGE_FUNCTION as Search, '=' as Operation and KYRIBA_CAMT53_IMPORT as Match.
  8. Navigate to group Destination Addresses and select Set Destination Addresses.
  9. Search for the Routing Address created above and select it as the Chain Link No 1.
  10. Add the standard CAM053 receiving routing address of the IFS application (Example_Receive_CAMT_053) as the Chain Link No 2.

CAMT054

Example connect configuration for execution of task in Kyriba with a specific process template to initiate the pulling of CAMT054 file.

  • Routing Rule: Example_Execute_CAMT_054_Kyriba_Task

  • Routing Address: Example_Execute_CAMT_054_Kyriba_Task

Configure Routing Address
  1. Navigate to Routing Addresses.
  2. Transport connector should be REST.
  3. Go to REST Address Data and fill the information as follows.
  4. Rest Root End Point: Provide the REST end point URL for for executing a task to import data through process template API service. (Example https://www.example.com/gateway/api/v1/process-templates/EXT_NOTIF_IFS/run)
  5. Use specific process template provided by Kyriba for CAMT054 in the EXT_NOTIF_IFS section on the URL.
  6. Client Id: The client identifier issued by Kyriba.
  7. Client Secret: The client secret issued by Kyriba.
  8. Token Endpoint: Provide the endpoint URL for authorization server. (Example https://www.example.com/gateway/oauth/token)
  9. Rest Http Method should be POST.
Configure Routing Rule
  1. Navigate to Routing Rules.
  2. Routing rule directions should be Outbound.
  3. Select APPLICATION_MESSAGE as Route From and ensure the Enable is selected.
  4. Enter a proper description in the Rule Name.
  5. Do not set a queue and select Finish.
  6. Navigate to group Content Based Conditions and add new. Add a condition as follows.
  7. MESSAGE_FUNCTION as Search, '=' as Operation and KYRIBA_CAMT54_TASK as Match.
  8. Navigate to group Destination Addresses and select Set Destination Addresses.
  9. Search for the Routing Address created above and select it.

Example connect configuration check for executed task status of the CAMT054 file.

  • Routing Rule: Example_Get_CAMT_054_Kyriba_Task_Status

  • Routing Address: Example_Get_CAMT_054_Kyriba_Task_Status

##### Configure Routing Address

  1. Navigate to Routing Addresses.
  2. Transport connector should be REST.
  3. Go to REST Address Data and fill the information as follows.

##### Configure Routing Rule

1.  Navigate to Routing Rules.
2.  Routing rule directions should be Outbound.
3.  Select **APPLICATION_MESSAGE** as Route From and ensure the Enable is selected.
4.  Enter a proper description in the Rule Name.
5.  Navigate to group Content Based Conditions and add new. Add a condition as follows.
6.  **MESSAGE_FUNCTION** as Search, **'='** as Operation and **KYRIBA_CAMT54_GET_STATUS** as Match.
7.  Navigate to group Destination Addresses and select Set Destination Addresses.
8.  Search for the Routing Address created above and select it.

Example connect configuration for import of the CAMT054 file using the executed task.

  • Routing Rule: Example_Import_CAMT_054_Kyriba_File

  • Routing Address: Example_Import_CAMT_054_Kyriba_File

Configure Routing Address
  1. Navigate to Routing Addresses.
  2. Transport connector should be REST.
  3. Go to REST Address Data and fill the information as follows.
  4. Rest Root End Point: Provide the REST end point URL for importing data through process template API service. (Example https://www.example.com/gateway/api/v1/process-templates/EXT_NOTIF_IFS/files)
  5. Use specific process template provided by Kyriba for CAMT054 in the EXT_NOTIF_IFS section on the URL.
  6. Client Id: The client identifier issued by Kyriba.
  7. Client Secret: The client secret issued by Kyriba.
  8. Token Endpoint: Provide the endpoint URL for authorization server. (Example https://www.example.com/gateway/oauth/token)
  9. Rest Http Method should be GET.
Configure Routing Rule
  1. Navigate to Routing Rules.
  2. Routing rule directions should be Outbound.
  3. Select APPLICATION_MESSAGE as Route From and ensure the Enable is selected.
  4. Enter a proper description in the Rule Name.
  5. Set the queue as OUT1 and select Finish.
  6. Navigate to group Content Based Conditions and add new. Add a condition as follows.
  7. MESSAGE_FUNCTION as Search, '=' as Operation and KYRIBA_CAMT54_IMPORT as Match.
  8. Navigate to group Destination Addresses and select Set Destination Addresses.
  9. Search for the Routing Address created above and select it as the Chain Link No 1.
  10. Add the standard CAM054 receiving routing address of the IFS application (Example_Receive_CAMT_054) as the Chain Link No 2.