If you want to integrate your company's system with the WEpayments system via API, you will need to create a specific user for this purpose, generate the API key, and configure the list of IPs authorized to use this key. In this article, we explain how to perform this process within the WEpayments panel.

Required access

Creating users for API integration and managing permissions are actions restricted to users with Moderator permission. This area is sensitive and should be managed by legal representatives or people with formal power of attorney to act on behalf of legal representatives.

Step 1: Create a unique user for API integration

1. Access the WEpayments dashboard with a moderator user.
2. In the side menu, click Settings > Access Control.
3. Click Create User.
4. Fill in the user details with information specifically for integration purposes — this can be a fictitious email address, just to create access. Example:
   • Username: API - Merchant Name
   • Email:** api.merchantname@yourcompany.com
5. Select the corresponding company and save the user.

This user should not be used for human login, as it may be deleted if it is linked to an employee who leaves the company. Ideally, it should be created solely for technical use, focused on integration.

Step 2: Assign permissions to the API user

After saving the user:

1. Locate the newly created user and click on it.
2. In the permissions section, check the features that the API can perform, such as:
   • Create charges (payin)
   • Create payments (payout)
   • View statement
   • Insert KYC documents
   • Other permissions compatible with the desired integration actions
3. Save the changes.

Step 3: Generate the API key

With the user configured:

1. On the user editing screen, locate the API Key section.

2. Click Create API Key.

    

On this screen, you will also need to enter at least one IP address in order to create the API key.

The key will only be available for viewing at the time of creation, so you will need to create it, collect it, and paste it into the target system.

In addition, for your security, we will request the 2-factor authentication code to create an API key, delete it, and add IP addresses to the list of allowed IP addresses.

Copy and store this key in a safe place.

Enter this key into your system so that it can communicate with WEpayments via API.

Only the IPs listed in this list will be able to make calls using the API key, as a security measure to prevent unauthorized access.

Final considerations

We recommend that these accesses be managed with caution, only by authorized persons.
In case of changes in your system infrastructure, remember to update the allowed IPs.
The API key and assigned permissions determine what your system can and cannot execute via integration.

If you have questions or need assistance, please contact our Support team on the chat in this page or email cs@wepayments.com.br.

Keywords: Create API key; Generate API key; Add IP; IPs.