Skip to main content
POST
/
v2
/
payout
/
transfers
Create Transfer
curl --request POST \
  --url https://api.sandbox.wepayout.com.br/v2/payout/transfers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "merchant_id": 123,
  "amount": 123,
  "invoice": "<string>",
  "beneficiary": {
    "name": "<string>",
    "document": {
      "type": "<string>",
      "number": "<string>"
    }
  },
  "notification_url": "<string>",
  "pix": {
    "pix_key": "<string>",
    "ispb": "<string>",
    "bank_branch": "<string>",
    "bank_branch_digit": "<string>",
    "account": "<string>",
    "account_digit": "<string>",
    "account_type": "<string>"
  }
}
'
{
  "id": 98765,
  "source_wallet_id": "wallet-uuid-source",
  "destination_wallet_id": "wallet-uuid-destination",
  "amount": 10000,
  "currency": "BRL",
  "description": "Transfer between accounts",
  "status": {
    "id": 1,
    "name": "Completed"
  },
  "external_id": "TRANSFER-001",
  "created_at": "2024-06-13T11:00:00.000000Z",
  "updated_at": "2024-06-13T11:00:00.000000Z"
}

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.

​
Request Body

​
merchant_id
integer
Merchant ID of the account creating the payout. Required when there is more than one account under your umbrella (sellers).Example: 123
​
amount
number
required
The payout amount in decimal format.Example: 150.75
​
invoice
string
required
Unique invoice identifier for this transfer.Example: PEDIDO-12345
​
beneficiary
object
required
Beneficiary information.
​
notification_url
string
URL where webhook notifications will be sent.Max length: 255 charactersExample: https://meusite.com/webhook
​
pix
object
required
PIX payment information. Use either pix_key OR bank account details.

​
Request Examples

​
PIX Key

cURL - PIX Key
curl --request POST \
  --url https://api.sandbox.wepayout.com.br/v2/payout/transfers \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "merchant_id": 123,
    "amount": 150.75,
    "invoice": "PEDIDO-12345",
    "beneficiary": {
      "name": "João da Silva",
      "document": {
        "type": "CPF",
        "number": "12345678901"
      }
    },
    "notification_url": "https://meusite.com/webhook",
    "pix": {
      "pix_key": "joao@email.com"
    }
  }'

​
Bank Account Details

cURL - Bank Account
curl --request POST \
  --url https://api.sandbox.wepayout.com.br/v2/payout/transfers \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "merchant_id": 123,
    "amount": 2500.00,
    "invoice": "FATURA-98765",
    "beneficiary": {
      "name": "Maria Oliveira",
      "document": {
        "type": "CPF",
        "number": "98765432100"
      }
    },
    "notification_url": "https://meusite.com/webhook",
    "pix": {
      "ispb": "00000000",
      "bank_branch": "1234",
      "bank_branch_digit": "1",
      "account": "987654",
      "account_digit": "0",
      "account_type": "CHECKING"
    }
  }'

{
  "id": 98765,
  "source_wallet_id": "wallet-uuid-source",
  "destination_wallet_id": "wallet-uuid-destination",
  "amount": 10000,
  "currency": "BRL",
  "description": "Transfer between accounts",
  "status": {
    "id": 1,
    "name": "Completed"
  },
  "external_id": "TRANSFER-001",
  "created_at": "2024-06-13T11:00:00.000000Z",
  "updated_at": "2024-06-13T11:00:00.000000Z"
}

Create Payment

Create an external payout payment

Get Balance

Check your wallet balance before creating transfers