Skip to main content

​
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 Types

Description: Account has been created but not yet reviewedNext Steps: Wait for compliance team reviewTypical Duration: 1-2 business days
Description: Compliance team is actively reviewing the accountNext Steps: May request additional documentationTypical Duration: 2-5 business days
Description: Account has been approved and is ready to useNext Steps: Start processing transactionsActions Available: All API endpoints accessible
Description: Account was rejected due to compliance issuesNext Steps: Review rejection reason and resubmit if possibleCommon Reasons: Invalid documentation, incomplete information, compliance concerns

​
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
/account/openingPOSTCreate new account opening request
/account/webhookPOSTRegister webhook for notifications
/account/webhookGETList registered webhooks
/account/webhook/{id}PUTUpdate webhook configuration
/account/webhook/{id}DELETERemove webhook

​
Webhook Integration

Stay informed about account status changes by setting up webhooks: 
// Register a webhook
const webhook = await fetch('https://api.wepayments.com/v1/account/webhook', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    url: 'https://your-domain.com/webhooks/onboarding',
    events: ['onboarding']
  })
});

​
Best Practices

Ensure all required fields are complete and properly formatted before submitting an account opening request.
Register your webhook endpoints before creating accounts to ensure you don’t miss any status updates.
Implement logic to handle all possible account statuses, including rejections.
Always store the account_id returned from the API for future reference.
Implement logging and monitoring for webhook deliveries to catch any issues.

​
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: [email protected]