Skip to main content
POST
/
v2
/
payout
/
payments
Create Payment
curl --request POST \
  --url https://api.sandbox.wepayout.com.br/v2/payout/payments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "merchant_id": 123,
  "payment_method": "<string>",
  "currency": "<string>",
  "country": "<string>",
  "amount": 123,
  "invoice": "<string>",
  "description": "<string>",
  "beneficiary": {
    "name": "<string>",
    "document": {
      "type": "<string>",
      "number": "<string>"
    },
    "birthdate": "<string>",
    "phone": "<string>",
    "address": {
      "address": "<string>",
      "city": "<string>",
      "country": "<string>",
      "state_code": "<string>",
      "zip_code": "<string>"
    }
  },
  "remitter": {
    "name": "<string>",
    "birthdate": "<string>",
    "country": "<string>"
  },
  "pix": {
    "pix_key": "<string>",
    "ispb": "<string>",
    "bank_branch": "<string>",
    "account": "<string>",
    "account_digit": "<string>",
    "account_type": "<string>"
  },
  "notification_url": "<string>",
  "purpose": "<string>",
  "receipt_message": "<string>"
}
'
{
  "id": 124118,
  "merchant": {
    "id": 477,
    "name": "Merchant Name"
  },
  "payment_method": "PIX",
  "country": "BR",
  "currency": "BRL",
  "amount": "R$43.34",
  "source_currency": null,
  "source_amount": null,
  "invoice": "6cc85ff5-7a35-45cb-a8fd-22b9bbe27896",
  "description": null,
  "authentication_code": null,
  "rejection_description": "",
  "notification_url": null,
  "status": {
    "id": 7,
    "name": "Awaiting"
  },
  "beneficiary": {
    "name": "João Silva",
    "document": {
      "type": "CPF",
      "number": "82608288200"
    },
    "birthdate": null,
    "phone": null,
    "address": {
      "address": null,
      "city": null,
      "country": null,
      "state_code": null,
      "zip_code": null
    }
  },
  "receipt_message": "",
  "pix": {
    "pix_key": "82608288200",
    "bank_code": "",
    "bank_branch": null,
    "bank_branch_digit": null,
    "account": null,
    "account_digit": null,
    "account_type": ""
  },
  "purpose": "20",
  "paid_at": null,
  "created_at": "2025-11-21T14:59:59.000000Z",
  "updated_at": "2025-11-21T14:59:59.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 that is creating the payout. The custom number will be different for sandbox and production environment.Is mandatory if there is more than one account under your umbrella (sellers).
​
payment_method
string
required
Payment method for the payout.Allowed values: PIX
​
currency
string
required
Currency code of the amount (ISO 4217).Example: BRL
​
country
string
required
Country code (ISO 3166-1 alpha-2).Example: BR
​
amount
number
required
The payout amount in decimal format.Example: 50.34
​
invoice
string
required
Unique invoice identifier (UUID format recommended).Example: e3317882-f821-455b-b082-dc3ba36e8a57
​
description
string
Description or purpose of the payout.Max length: 255 characters
​
beneficiary
object
required
Beneficiary information.
​
remitter
object
Details of remitter. Mandatory for the remittance model. Payments from individuals to individuals.
​
pix
object
required
PIX payment information. Use either pix_key OR bank account details.
​
notification_url
string
URL where webhook notifications will be sent.Max length: 255 characters
​
purpose
string
Purpose code for the transaction.Default: 20
​
receipt_message
string
Custom message to appear on the receipt.

​
Response

​
id
integer
WEpayment’s auto generated payout ID.
​
merchant
object
Merchant information.
​
payment_method
string
Payment method used.
​
country
string
Country code.
​
currency
string
Currency code.
​
amount
string
Payout amount formatted with currency symbol.
​
source_currency
string
Source currency if conversion was applied.
​
source_amount
string
Source amount if conversion was applied.
​
invoice
string
Invoice identifier.
​
description
string
Payout description.
​
authentication_code
string
Authentication code for the transaction.
​
rejection_description
string
Description if the payout was rejected.
​
notification_url
string
Webhook notification URL.
​
status
object
Payout status.
​
beneficiary
object
Beneficiary information.
​
receipt_message
string
Receipt message.
​
pix
object
PIX payment details.
​
purpose
string
Transaction purpose code.
​
paid_at
string
Payment completion timestamp.
​
created_at
string
Creation timestamp.
​
updated_at
string
Last update timestamp.

​
Request Examples

​
PIX Key Payment

Use this method when you have the beneficiary’s PIX key. 
curl --location 'https://api.sandbox.wepayout.com.br/v2/payout/payments' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_TOKEN' \
  --data '{
    "payment_method": "PIX",
    "currency": "BRL",
    "country": "BR",
    "amount": 43.34,
    "invoice": "c071bcc5-0c1c-450b-a47f-15fc5321fbe3",
    "beneficiary": {
      "name": "João Silva",
      "document": {
        "type": "CPF",
        "number": "82608288200"
      }
    },
    "pix": {
      "pix_key": "82608288200"
    }
  }'

​
Bank Account Payment

Use this method when you have the beneficiary’s bank account details. 
curl --location 'https://api.sandbox.wepayout.com.br/v2/payout/payments' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_TOKEN' \
  --data '{
    "payment_method": "PIX",
    "currency": "BRL",
    "country": "BR",
    "amount": 50.34,
    "invoice": "e3317882-f821-455b-b082-dc3ba36e8a57",
    "beneficiary": {
      "name": "Maria Santos",
      "document": {
        "type": "CPF",
        "number": "58713371126"
      }
    },
    "pix": {
      "ispb": "18236120",
      "bank_branch": "0496",
      "account": "51659",
      "account_digit": "7",
      "account_type": "CHECKING"
    }
  }'

{
  "id": 124118,
  "merchant": {
    "id": 477,
    "name": "Merchant Name"
  },
  "payment_method": "PIX",
  "country": "BR",
  "currency": "BRL",
  "amount": "R$43.34",
  "source_currency": null,
  "source_amount": null,
  "invoice": "6cc85ff5-7a35-45cb-a8fd-22b9bbe27896",
  "description": null,
  "authentication_code": null,
  "rejection_description": "",
  "notification_url": null,
  "status": {
    "id": 7,
    "name": "Awaiting"
  },
  "beneficiary": {
    "name": "João Silva",
    "document": {
      "type": "CPF",
      "number": "82608288200"
    },
    "birthdate": null,
    "phone": null,
    "address": {
      "address": null,
      "city": null,
      "country": null,
      "state_code": null,
      "zip_code": null
    }
  },
  "receipt_message": "",
  "pix": {
    "pix_key": "82608288200",
    "bank_code": "",
    "bank_branch": null,
    "bank_branch_digit": null,
    "account": null,
    "account_digit": null,
    "account_type": ""
  },
  "purpose": "20",
  "paid_at": null,
  "created_at": "2025-11-21T14:59:59.000000Z",
  "updated_at": "2025-11-21T14:59:59.000000Z"
}

Payout Webhook

Receive real-time payout status notifications

Get Balance

Check your wallet balance before creating payouts