Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.wepayout.co/llms.txt

Use this file to discover all available pages before exploring further.

​
Account Reference

The WEpayments account system allows you to onboard new businesses and manage their verification process through our API.

​
What is an Account?

An account represents a business entity that wants to use WEpayments services. Each account goes through a verification process before being approved for transactions.

​
Account Lifecycle

1

Account Opening

Submit business information and documentation through the API
2

Verification

Our compliance team reviews the submitted information
3

Approval/Rejection

Account is either approved or rejected with feedback
4

Active

Approved accounts can start processing transactions

​
Key Features

Automated Onboarding

Programmatically create and manage accounts via API

Real-time Notifications

Receive webhook notifications for status changes

Document Management

Submit and track required documentation

Compliance Ready

Built-in KYC/KYB verification process

​
Account Status

​
Status Flow

​
Status Types

Description: First status of the process. Indicates that the account opening request has been received and is awaiting review.Next Steps: Wait for compliance team to start the review processTypical Duration: 1-2 business days
Description: Compliance is analyzing the Due Diligence (DD) and company data provided during onboarding.Next Steps: May request additional documentation if neededTypical Duration: 2-5 business days
Description: Account is active/approved. At this status, the webhook will send the account_id (MID - Merchant ID) that identifies the merchant’s account.Next Steps: Start processing transactionsActions Available: All API endpoints accessible
Description: Account was canceled during the onboarding process.Next Steps: Review cancellation reason and resubmit if possibleCommon Reasons: Invalid documentation, incomplete information, compliance concerns
Description: Account is inactive after being previously activated.Next Steps: Contact support to understand the reason and reactivation process
Description: Account has been closed.Next Steps: Account cannot be reactivated. A new account opening request is required if needed.

​
Required Information

To open an account, you need to provide:

​
Business Information

  • Legal business name
  • Business document (CNPJ for Brazil)
  • Business email and phone
  • Complete business address

​
Representative Information

  • Full name of legal representative
  • Personal document (CPF for Brazil)
  • Email and phone
  • Birth date

​
Additional Documents

Depending on your business type, you may need to provide:
  • Articles of incorporation
  • Proof of address
  • Bank account information
  • Business licenses

​
API Endpoints

The Account API provides the following endpoints:
EndpointMethodDescription
/v2/register/companiesPOSTCreate new account opening request
/v2/register/companies/webhooksPOSTRegister webhook for notifications
/v2/register/companies/webhooksGETList registered webhooks
/v2/register/companies/webhooks/{event}PUTUpdate webhook configuration
/v2/register/companies/webhooks/{event}DELETERemove webhook

​
Next Steps

Opening Process

Learn how to create an account

Webhook Integration

Set up real-time notifications

API Reference

View complete API documentation

Authentication

Learn about API authentication

​
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: cs@wepayments.com.br