# WEpayments API

## Docs

- [Reference](https://docs.wepayout.co/account/reference.md): Understanding account management in WEpayments
- [Change Fee Target Account](https://docs.wepayout.co/api-reference/account/change-fee-target.md): Transfer Cashout fee from one account to another within the same customer domain
- [Account Opening Request](https://docs.wepayout.co/api-reference/account/create.md): API for creating onboarding requests for corporate account (legal entities). To successfully create a corporate account, you must provide at least one administrator and one legal representative.
- [Get Account Opening Request By ID](https://docs.wepayout.co/api-reference/account/get-account-by-id.md): Retrieve a single account opening request using its unique identifier. Returns all details of the request including company information, contacts, addresses, status, and history.
- [Get Balance](https://docs.wepayout.co/api-reference/account/get-balance.md): Check the balance of all the accounts you have access to
- [Get Balance Specific Day](https://docs.wepayout.co/api-reference/account/get-balance-specific-day.md): Check what the account balance was on a specific day
- [Get Statement](https://docs.wepayout.co/api-reference/account/get-statement.md): Retrieve account statement with transaction history
- [List Account Opening Requests](https://docs.wepayout.co/api-reference/account/list-accounts.md): Retrieves a list of all account opening requests submitted through the registration process.
- [Onboarding Webhook](https://docs.wepayout.co/api-reference/account/webhook/webhook-onboarding.md): For each onboarding status change, a webhook will be sent for the following statuses:
- [Query](https://docs.wepayout.co/api-reference/account/webhook/webhook-query.md): Query the registered webhook URLs
- [Remove](https://docs.wepayout.co/api-reference/account/webhook/webhook-remove.md): Remove a registered webhook
- [Setup](https://docs.wepayout.co/api-reference/account/webhook/webhook-setup.md): Register a webhook URL to receive automatic notifications about relevant events
- [Update](https://docs.wepayout.co/api-reference/account/webhook/webhook-update.md): Update an existing webhook configuration
- [Cancel Authorization](https://docs.wepayout.co/api-reference/automatic-pix/authorizations/cancel.md): Cancel an authorization
- [Get Authorization](https://docs.wepayout.co/api-reference/automatic-pix/authorizations/get.md): Get an authorization by ID
- [List Authorizations](https://docs.wepayout.co/api-reference/automatic-pix/authorizations/list.md): List all authorizations
- [Update Authorization](https://docs.wepayout.co/api-reference/automatic-pix/authorizations/update.md): Update an authorization amount
- [Cancel Schedule](https://docs.wepayout.co/api-reference/automatic-pix/schedules/cancel.md): Cancel a schedule
- [Get Schedule](https://docs.wepayout.co/api-reference/automatic-pix/schedules/get.md): Get a schedule by ID
- [List Schedules](https://docs.wepayout.co/api-reference/automatic-pix/schedules/list.md): List all schedules
- [Update Schedule](https://docs.wepayout.co/api-reference/automatic-pix/schedules/update.md): Update a schedule amount
- [List Authorization History Webhooks](https://docs.wepayout.co/api-reference/automatic-pix/webhooks/list-authorization-history.md): List webhooks for an authorization history
- [List Schedule Webhooks](https://docs.wepayout.co/api-reference/automatic-pix/webhooks/list-schedule.md): List webhooks for a schedule
- [Resend Authorization Webhook](https://docs.wepayout.co/api-reference/automatic-pix/webhooks/resend-authorization-history.md): Resend a webhook for an authorization history
- [Resend Schedule Webhook](https://docs.wepayout.co/api-reference/automatic-pix/webhooks/resend-schedule.md): Resend a webhook for a schedule history
- [List Institutions](https://docs.wepayout.co/api-reference/banks/list-institutions.md): Return the list of banks available in Brazil
- [Cancel Charge](https://docs.wepayout.co/api-reference/cash-in/payin/cancel-charge.md): Request the cancellation of Payins of type boleto or pix
- [Create Charge](https://docs.wepayout.co/api-reference/cash-in/payin/create-charge.md): Generate a new QR Code Pix or Boleto payment request
- [Get Unique Charge](https://docs.wepayout.co/api-reference/cash-in/payin/get-unique-charge.md): Get details of a specific charge by ID
- [List Charge](https://docs.wepayout.co/api-reference/cash-in/payin/list-charge.md): List all charges with optional filters
- [Create Refund](https://docs.wepayout.co/api-reference/cash-in/refund/create-refund.md): Create a new refund. To initiate the refund, you must provide the unique identifier of the Pix or credit card payment in the {id} parameter.
- [Get Unique Refund](https://docs.wepayout.co/api-reference/cash-in/refund/get-unique-refund.md): Returns the refund using its unique identifier
- [Resend Payin Webhooks (Bulk)](https://docs.wepayout.co/api-reference/cash-in/webhooks/resend-bulk.md): Dispatch a bulk job to resend payin webhook notifications for a given merchant and time range
- [Resend Job Status](https://docs.wepayout.co/api-reference/cash-in/webhooks/resend-bulk-status.md): Check the progress and status of a bulk payin webhook resend job
- [Create Payment](https://docs.wepayout.co/api-reference/cash-out/payout/create-payment.md): Create a new payout payment to transfer funds
- [Create Transfer](https://docs.wepayout.co/api-reference/cash-out/payout/create-transfer.md): Create a new payout transfer to an external beneficiary via PIX
- [Decode QR Code](https://docs.wepayout.co/api-reference/cash-out/payout/decode-qr-code.md): Decode third-parties PIX QR codes to make them payable at the create payment endpoint
- [Get Unique Payment](https://docs.wepayout.co/api-reference/cash-out/payout/get-unique-payment.md): Get details of a specific payout payment by ID
- [List Payment](https://docs.wepayout.co/api-reference/cash-out/payout/list-payment.md): List all payout payments with optional filters
- [Resend Payout Webhooks (Bulk)](https://docs.wepayout.co/api-reference/cash-out/webhooks/resend-bulk.md): Dispatch a bulk job to resend payout webhook notifications for a given merchant and time range
- [Resend Job Status](https://docs.wepayout.co/api-reference/cash-out/webhooks/resend-bulk-status.md): Check the progress and status of a bulk payout webhook resend job
- [Create Charge](https://docs.wepayout.co/api-reference/credit-card/create-charge.md): Create a new credit card charge with payment page or transparent checkout
- [Create Data Qualification](https://docs.wepayout.co/api-reference/data-qualification/create-data-qualification.md): Register a batch of data qualification orders
- [Get Data Qualification By Custom Code](https://docs.wepayout.co/api-reference/data-qualification/get-by-custom-code.md): Find a data qualification order using custom code
- [Get Data Qualification By ID](https://docs.wepayout.co/api-reference/data-qualification/get-by-id.md): Retrieve information for a specific data qualification process
- [Get Data Qualification Services](https://docs.wepayout.co/api-reference/data-qualification/get-services.md): Retrieve available data qualification services
- [Get Data Qualification Statuses](https://docs.wepayout.co/api-reference/data-qualification/get-status.md): Retrieve all available data qualification statuses
- [List Data Qualifications](https://docs.wepayout.co/api-reference/data-qualification/list-data-qualification.md): Retrieve a paginated, filterable and sortable list of data qualification processes
- [Get KYC By ID](https://docs.wepayout.co/api-reference/kyc/get.md): This route is performed using the KYC ID. If a KYC with the provided ID exists, it will be retrieved; otherwise, an empty response will be returned.
- [Get KYC By Document](https://docs.wepayout.co/api-reference/kyc/get-by-document.md): This data can be used in the "kyc-proof-url" of a KYC. If no document is found for this cpf/cnpj, the request will return an empty array. If a KYC with the provided document exists, only the most recent KYC record for that document will be returned. When you provide a cpf or cnpj, you will be inform…
- [List KYC](https://docs.wepayout.co/api-reference/kyc/list-kyc.md): Retrieves a list of pending KYC verifications
- [Submit Document For KYC](https://docs.wepayout.co/api-reference/kyc/submit-document.md): Submit documents for a pending KYC verification
- [KYC Webhook](https://docs.wepayout.co/api-reference/kyc/webhook.md): For each KYC status change, a webhook will be sent for the following statuses
- [Create Merchant Markup Configuration](https://docs.wepayout.co/api-reference/markup/account/create-merchant-markup.md): Create markup configuration for a merchant by product and payment method.
- [List Merchant Markups Configuration](https://docs.wepayout.co/api-reference/markup/account/list-merchant-markups.md): List markup configurations for merchants with optional filters.
- [Update Merchant Markup Configuration](https://docs.wepayout.co/api-reference/markup/account/update-merchant-markup.md): Update markup configuration for a merchant by markup ID.
- [Create Payin with Global Markup](https://docs.wepayout.co/api-reference/markup/payin/create-payin-with-global-markup.md): Create a payin charge using global markup configuration.
- [Create Payin with Inline Markup](https://docs.wepayout.co/api-reference/markup/payin/create-payin-with-inline-markup.md): Create a payin charge with inline markup configuration.
- [Create Payout with Global Markup](https://docs.wepayout.co/api-reference/markup/payout/create-payout-with-global-markup.md): Create a payout payment using global markup configuration.
- [Create Payout with Inline Markup](https://docs.wepayout.co/api-reference/markup/payout/create-payout-with-inline-markup.md): Create a payout payment with inline markup configuration.
- [Authentication](https://docs.wepayout.co/authentication.md): Learn how to authenticate with the WEpayments API
- [Reference](https://docs.wepayout.co/banks/reference.md): Understanding bank institutions in WEpayments
- [About Charges](https://docs.wepayout.co/cash-in/about-charges.md): Understanding the Payin solution and payment types
- [Automatic Pix](https://docs.wepayout.co/cash-in/automatic-pix.md): Recurring payments with Pix
- [Boleto](https://docs.wepayout.co/cash-in/boleto.md): Traditional payment method in Brazil
- [Payin Webhook](https://docs.wepayout.co/cash-in/payin-webhook.md): Receive real-time notifications about payin status changes
- [Pix QR Code](https://docs.wepayout.co/cash-in/pix-qr-code.md): Instant payments available 24/7
- [Rejection Reasons](https://docs.wepayout.co/cash-in/rejection-reasons.md): Understanding payin rejection codes and error messages
- [Payin Status Flow](https://docs.wepayout.co/cash-in/status-flow.md): Understanding the lifecycle of PIX and Boleto payin transactions
- [Test Documents](https://docs.wepayout.co/cash-in/test-documents.md): Use these test documents to simulate different payin scenarios in the sandbox environment. Each CPF number triggers specific charge outcomes for testing your integration.
- [About Payments](https://docs.wepayout.co/cash-out/about-payments.md): Understanding the Payout solution and payment types
- [Payment Methods Guide](https://docs.wepayout.co/cash-out/payment-methods-guide.md): Understanding Bank Account Data vs PIX Key for payments
- [Payout Webhook](https://docs.wepayout.co/cash-out/payout-webhook.md): Receive real-time notifications about payout status changes
- [Rejection Reasons](https://docs.wepayout.co/cash-out/rejection-reasons.md): Understanding payout rejection codes and error messages
- [Payout Status Flow](https://docs.wepayout.co/cash-out/status-flow.md): Understanding the lifecycle of PIX and TED payout transactions
- [Test Documents](https://docs.wepayout.co/cash-out/test-documents.md): Test documents for payout scenarios in sandbox environment
- [Webhook Signature](https://docs.wepayout.co/concepts/webhooks.md): Learn how to verify webhook signatures to ensure secure communication
- [About](https://docs.wepayout.co/credit-card/about-credit-card.md): Learn how credit card charges work in WEPayments
- [Rejection Status](https://docs.wepayout.co/credit-card/rejection-status.md): Understanding credit card rejection reasons and status codes
- [Test Cards](https://docs.wepayout.co/credit-card/test-cards.md): Everything you need to know about test cards
- [Transparent Checkout](https://docs.wepayout.co/credit-card/transparent-checkout.md): Everything you need to know about our transparent checkout
- [Credit Card Webhook](https://docs.wepayout.co/credit-card/webhook.md): Receive real-time notifications about credit card transaction status changes
- [FAQ](https://docs.wepayout.co/faq.md): Frequently asked questions about WEPayments API
- [CPF Mismatch](https://docs.wepayout.co/features/cpf-mismatch.md): Prevent fraud by ensuring CPF verification on deposits and withdrawals
- [Going to Production](https://docs.wepayout.co/going-to-production.md): Checklist and best practices for launching your integration
- [About Markup](https://docs.wepayout.co/markup/about-markup.md): Understanding markup solution
- [Creating Markup via API](https://docs.wepayout.co/markup/creating-markup-api.md): How to configure markup for merchants using the API.
- [Model Context Protocol (MCP)](https://docs.wepayout.co/model-context-protocol.md): Connect our documentation to your AI tools via MCP

## OpenAPI Specs

- [openapi](https://docs.wepayout.co/api-reference/openapi.json)