WebHook configuration

⚙️ Configuration parameters required by the customer

📢 Considerations

Authentication

By authentication type (Basic or OAuth2) the following data is requested (required):

• OAuth2: Username, Password, AuthEndPoint

  1. Username : User name.
  2. Password : User password.
  3. AuthEndPoint : Authentication endPoint Url.

• Basic: Username, Password

  1. Username : User name.
  2. Password : User password.

The events (notifications) will be sent to the registered endPoints in JSON format. Therefore a server capable of handling events and converting them to a format compatible with the target application must be configured.

📩 Receipt of a notification

If the process was successful, the client server will receive the payload with the event information (notification).
The following data is sent per webhook type:

➾ Type Conciliation document notification

1. Request webhook

   ---

   Ex. Successful request

   {
       "FileUrl": "string",
       "BankId": "BLNI",
       "Date": "2017-10-27T17:31:08.058Z",
       "Summary": {
           "TotalProcessedAccounts": number,
           "TotalAccounts": number,
           "UnprocessedAccounts": [
                "string1", 
                "String2"
              ],
           "NotAllowedAccounts": [
                "string1", 
                "String2"
              ],
           "AlreadyProcessedAccounts": [
                "string1", 
                "String2"
              ]
          }
   }

2. Detail of outgoing JSON members of the process

   ---

   JSON Member	Name	Description	Type
   FileUrl	URL.	Url of the file in S3. Reconciliation by country and client.	string
   BankId	Originating bank.	Originating bank code.	string
   Date	Reconciliation date.	Reconciliation date.	date
   Summary	Reconciliation data.	Object containing the reconciliation data.	object
   Summary.TotalProcessedAccounts	Total processed.	Total transfers processed correctly.	number
   Summary.TotalAccounts	Total accounts.	Total accounts, including successful and unsuccessful accounts.	number
   Summary.UnprocessedAccounts[]	Total accounts not processed.	List of unprocessed accounts.	array of string
   Summary.NotAllowedAccounts[]	Total accounts not allowed.	List of accounts without consent.	array of string
   Summary.AlreadyProcessedAccounts[]	Previously processed.	List of accounts processed prior to the same day, therefore the application is excluded.	array of string