> ## 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.

# About Payments

> Understanding the Payout solution and payment types

# About payments

In general, with our Payout product you can:

* Create payout
* Request payout cancelation
* Issue proof of payout
* Check your wallet balance
* Consult status of payout
* Filter, sort and export lists of payout
* Filter, sort and export lists of bank statement

## Payments type: PIX and TED

We process two types of payments for Pay Out: **PIX (Brazilian instant payment)** and **bank debit** and **TED (Brazilian electronic bank transfer)**. Payments which you choose for your processing flow are pre-configured by our team, and you are faced with different contexts. For example:

### INSTANT PAYMENT PROCESSING

**Processing window**: 24/7, including weekends and holidays.

**Confirmation**: D+1

**Payment information required**: bank details + bank code + branch + account and account digit.

### BANK DEBIT PAYMENT PROCESSING

**Processing window**: on banking business hours only.

**Confirmation**: D+1

**Payment information required**: bank details + bank code + branch + account and account digit.

## Type of operation for International Merchant

There are two types of operations, you may consult our team to check which meets your company profile and contract.

* **Usual Payments**: Payments related to goods and services. In this case you will be asked to inform the payer origin.
* **Usual Payments**: Payments related to goods and services. In this case you will be asked to inform the payer origin and country information.

## PIX (Instant Payment)

### What is PIX?

A Brazilian payment solution that settles funds transfers in a few seconds, ensuring the immediate availability of funds to the final beneficiary.

### PIX Key

The PIX key is used to link the user's information to the bank transfer details, which may be a **CPF/CNPJ** (number), **PIX**, e-mail, cell phone or random key. Know more about PIX in the [Brazil central bank homepage](https://www.bcb.gov.br/estabilidadefinanceira/pix).

## CPF and CNPJ

The Cadastro de Pessoas Físicas (CPF, Portuguese for "Natural Persons Register") is the Brazilian individual taxpayer registry identification, since 1968 maintained by the Receita Federal do Brasil (Federal Revenue of Brazil). It is an 11-digit number, who pay taxes or take part, directly or indirectly, in activities that provide revenue for any of the dozens of different types of taxes.

A CPF is 11 digits long, with nine base digits, and two digits at the end that are the result of an arithmetic operation on the first nine digits. The format of a CPF is: 731.001.94200.

A CNPJ is also a taxpayer identification number, but it is used for businesses, real institutions. All businesses that are formed in Brazil must apply for a CNPJ, and it is the number at the time of formation. Foreign companies that wish to invest or own assets in Brazil must also have a CNPJ number.

A CNPJ is a 14-digit number: 12 base digits and two digits at the end that are the result of an arithmetic formula of the base numbers, making any typing mistakes when entering the number lead to an invalid number. Here is an example of a CNPJ: XX.XXX.XXX/0001-XX.

## Brazilian Bank Account Information

In Brazil there are two types of bank data, the pix key and the conventional data, which are composed of:

All bank accounts in Brazil have the following information:

* **Bank code**: this is the number with 3 characters that specifies which is the bank (each bank has its own code, for example 341 is Itaú)
* **Bank branch**: this is the branch number (agência in Portuguese) for each account (in case that 4 numbers, the mandatory is only the 4 first, for example 1234-5)
* **Bank type code**: Mandatory field to identify the type of bank account. It can be up to 2 characters normally, it depends on the bank
* **Branch code**: code variation, just as the bank's branch number is the last number
* **Account number**: mandatory number to identify the account. It can be up to 15 characters normally, it depends on the bank
* **Account digit**: mandatory number to identify the account (final, it is always the last number of the account, for example 1827167 / 1 - 1 is the account digit, and 1827167 is the account number, and this information is obtained from the account number.
* **Account type**: Mandatory field to identify account type. Y for Savings and C for checking.

Bank account number can be used for electronic payment or instant payment methods. The pix key is only available for instant payments (pix).

## Payment Flow

<CardGroup cols={2}>
  <Card title="PIX" icon="bolt" color="#32BCAD">
    **Speed**: Instant (seconds)

    **Availability**: 24/7

    **Payment Method**: PIX key or bank account

    **Confirmation**: Real-time

    **Best for**: Instant transfers, urgent payments
  </Card>

  <Card title="TED" icon="building-columns" color="#3B82F6">
    **Speed**: D+1

    **Availability**: Business hours

    **Payment Method**: Bank account details

    **Confirmation**: Next business day

    **Best for**: Traditional bank transfers, scheduled payments
  </Card>
</CardGroup>

## Use Cases

<AccordionGroup>
  <Accordion title="Marketplace Payouts">
    Pay sellers and partners for their sales or services on your marketplace platform.
  </Accordion>

  <Accordion title="Freelancer Payments">
    Process payments to freelancers and contractors for completed work.
  </Accordion>

  <Accordion title="Supplier Payments">
    Pay suppliers and vendors for goods and services.
  </Accordion>

  <Accordion title="Refunds">
    Process refunds to customers by sending money back to their accounts.
  </Accordion>

  <Accordion title="Affiliate Commissions">
    Pay commissions to affiliates and partners for referrals.
  </Accordion>

  <Accordion title="Salary Payments">
    Process salary and wage payments to employees.
  </Accordion>
</AccordionGroup>

## Getting Started

<Steps>
  <Step title="Create Your First Payment">
    Use the [Create Payment](/api-reference/cash-out/payout/create-payment) endpoint to send funds to a recipient.
  </Step>

  <Step title="Monitor Payment Status">
    Use the [Get Unique Payment](/api-reference/cash-out/payout/get-unique-payment) endpoint to check payment status.
  </Step>

  <Step title="List All Payments">
    Use the [List Payment](/api-reference/cash-out/payout/list-payment) endpoint to view all your payments with filters.
  </Step>

  <Step title="Set Up Webhooks">
    Configure [Callback Payment](/api-reference/cash-out/payout/callback-payment) to receive real-time payment notifications.
  </Step>
</Steps>

## Payment Requirements

### For PIX Payments

<Note>
  **Required Information**:

  * Recipient name
  * Recipient document (CPF or CNPJ)
  * PIX key (CPF, CNPJ, email, phone, or random key)
  * Amount
</Note>

### For TED/Bank Transfer Payments

<Note>
  **Required Information**:

  * Recipient name
  * Recipient document (CPF or CNPJ)
  * Bank code (3 digits)
  * Branch number (agência)
  * Account number
  * Account digit
  * Account type (checking or savings)
  * Amount
</Note>

## Best Practices

<CardGroup cols={2}>
  <Card title="Verify Recipient Data" icon="shield-check" color="#10B981">
    Always validate recipient information before processing payments to avoid errors.
  </Card>

  <Card title="Check Balance" icon="wallet" color="#3B82F6">
    Verify sufficient balance before creating payments to prevent failures.
  </Card>

  <Card title="Use Webhooks" icon="webhook" color="#8B5CF6">
    Implement webhooks to receive real-time payment status updates.
  </Card>

  <Card title="Track with External ID" icon="tag" color="#F59E0B">
    Use external\_id to track payments in your system and prevent duplicates.
  </Card>
</CardGroup>

## Payment Status Flow

```mermaid theme={null}
graph TD
    A[Created] --> B[Processing]
    B --> C{Success?}
    C -->|Yes| D[Paid]
    C -->|No| E[Failed]
    B --> F[Rejected]
    A --> G[Cancelled]
```

## Next Steps

<CardGroup cols={2}>
  <Card title="Create Payment" icon="plus" href="/api-reference/cash-out/payout/create-payment">
    Learn how to create your first payout
  </Card>

  <Card title="Decode QR Code" icon="qrcode" href="/api-reference/cash-out/payout/decode-qr-code">
    Pay third-party PIX QR Codes
  </Card>

  <Card title="Create Transfer" icon="arrow-right-arrow-left" href="/api-reference/cash-out/payout/create-transfer">
    Transfer between wallets
  </Card>

  <Card title="Get Balance" icon="wallet" href="/api-reference/account/get-balance">
    Check your wallet balance
  </Card>

  <Card title="Callback Payment" icon="webhook" href="/api-reference/cash-out/payout/callback-payment">
    Set up payment notifications
  </Card>

  <Card title="Get Statement" icon="file-invoice" href="/api-reference/account/get-statement">
    View your account statement
  </Card>
</CardGroup>

## Additional Notes

<Note>
  For international merchants, additional documentation and compliance requirements may apply. Contact our support team for more information.
</Note>

<Warning>
  Payment processing times may vary depending on the recipient's bank and the payment method used. PIX payments are instant, while TED payments are processed on the next business day.
</Warning>

<Tip>
  Use PIX for urgent payments and TED for scheduled or traditional bank transfers. Consider the recipient's preference and urgency when choosing the payment method.
</Tip>
