Skip to main content

​
Introduction

In this document, you will find the first steps to integrate with the WEpayments API.

​
Environments

Our API is available in two independent environments: Sandbox (Test) and Production (Real), below we will explain details about each of them.

​
Sandbox (Testing Environment):

The sandbox environment is a space where you can test and validate API integration before starting real operations. The APIs available are identical to those in production, but some custom variables may differ, such as the go-live date for new features. We use this environment to launch new features early, giving you sufficient time to prepare for production. API: https://api.sandbox.wepayout.com.br
Dashboard URL: https://app.sandbox.wepayout.co

​
Production (Real Environment):

The production environment is where you will make actual payments (payout) and charges (payin). Unlike the sandbox environment, all payments here are real and will be processed accordingly. API: https://api.wepayout.com.br
Dashboard URL: https://app.wepayout.co/

​
Authentication

Tutorial: Follow this step-by-step guide to create your API key: How to create an API key in the WEpayments system

​
Important information:

  • The API-Key must be included in the authorization header as an RFC 6750 Bearer Token.
  • For the API-Key to work in production, you must provide the IP addresses of your server.
  • Your API-Key carries many privileges, so make sure to keep it secret! Do not include it in URLs or expose it on the front end of your application.
  • The API-Key is unique for each environment, so you will have one in Sandbox and a different one in production.
INFORMATIONDATA
Security Scheme TypeHTTP
HTTP Authorization Schemebearer
Bearer Format”API-Key”

​
Quick Navigation

Authentication

Learn how to authenticate your API requests

Webhook Signature

Learn how to verify webhook signatures

Going to Production

Checklist for launching your integration

KYC

Know Your Customer verification

​
Integration Steps

1

Get Your API Keys

Follow the tutorial to create your API key in the WEpayments system.
2

Set Up Authentication

Configure your application to authenticate API requests using your API key as a Bearer token
3

Test in Sandbox

Use our sandbox environment to test your integration without processing real payments
4

Implement Webhooks

Set up webhook endpoints and verify signatures to receive real-time notifications
5

Go Live

Provide your production IP addresses and start accepting real payments

​
API Basics

​
Base URLs

Sandbox: 
https://api.sandbox.wepayout.com.br
Production: 
https://api.wepayout.com.br

​
Authentication

All API requests require authentication using a Bearer token: 
Authorization: Bearer YOUR_API_KEY

​
Request Format

All requests should use JSON format: 
Content-Type: application/json

​
Your First API Call

Let’s make a simple request to verify your setup: 
curl https://api.sandbox.wepayout.com.br/v1/account/balance \
  -H "Authorization: Bearer YOUR_SANDBOX_API_KEY" \
  -H "Content-Type: application/json"

​
Next Steps

Create Charge

Start accepting payments (Payin)

Create Payment

Make payouts (Payout)

List Banks

Get list of supported banks

Account Balance

Check your account balance

​
Need Help?

24/7 Support Team: Our Support, Performance & CX team is available for operational and technical assistance.
  • 📚 Help Center: Access articles on panel usage, transactions, payments, withdrawals, reports, and more. Visit Help Center
  • 💬 Chat: Click the chat icon in the bottom-right corner of any Help Center page
  • 📱 WhatsApp: +55 41 9266-7191
  • 📧 E-mail: [email protected]
Important: Always start with the Sandbox environment to test your integration. Remember that API keys are unique for each environment.