Skip to main content
POST
/
v2
/
payin
/
payments
Create Charge (Bank Slip)
curl --request POST \
  --url https://api.sandbox.wepayout.com.br/v2/payin/payments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "merchant_id": 123,
  "invoice": "<string>",
  "notification_url": "<string>",
  "payment_method": "<string>",
  "amount": 123,
  "currency": "<string>",
  "country": "<string>",
  "description": "<string>",
  "buyer": {
    "name": "<string>",
    "email": "<string>",
    "document": {
      "type": "<string>",
      "number": "<string>"
    },
    "address": {
      "street": "<string>",
      "number": "<string>",
      "zipcode": "<string>",
      "city": "<string>",
      "district": "<string>",
      "state_code": "<string>"
    }
  },
  "originator_legal_entity": {},
  "boleto": {
    "expire_date": "<string>"
  }
}
'
{
  "id": 123,
  "merchant": {
    "id": 123,
    "name": "<string>"
  },
  "hash": "<string>",
  "payment_page": "<string>",
  "our_number": "<string>",
  "invoice": "<string>",
  "notification_url": "<string>",
  "payment_method": "<string>",
  "amount": 123,
  "paid_amount": 123,
  "refunded_amount": 123,
  "currency": {
    "id": 123,
    "name": "<string>",
    "code": "<string>",
    "symbol": "<string>"
  },
  "description": "<string>",
  "buyer": {},
  "originator_legal_entity": {},
  "boleto": {
    "expire_date": "<string>",
    "digitable_line": "<string>",
    "bar_code_number": "<string>",
    "agreement": {},
    "fine": {},
    "discount": {}
  },
  "status": {
    "id": 123,
    "name": "<string>"
  },
  "status_history": [
    {}
  ],
  "substatus": {},
  "refunds": [
    {}
  ],
  "created_at": "<string>",
  "updated_at": "<string>"
}

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.

​
Create Charge (Bank Slip)

Generate a new Boleto payment request.

​
Request Body

​
merchant_id
integer
Merchant id of the account that is creating the payin. Mandatory if there is more than one account under your umbrella (sellers).
​
invoice
string
required
Your identification number, it must be unique on our database.
​
notification_url
string
The url where we will submit the callbacks.
​
payment_method
string
required
Payment method that will be used in payin.Allowed value: boleto
​
amount
integer
required
The charge total amount in the smallest currency unit.Min: 500
​
currency
string
required
Currency code of the amount (ISO 4217). Example: BRL
​
country
string
required
Country code (ISO 3166-1 alpha-2). Example: BR
​
description
string
Instructions that will be displayed to the user.
​
buyer
object
required
The person you are charging object.
​
originator_legal_entity
object
required
Use this object to inform the legal name of the final beneficiary.
​
boleto
object
required
Boleto specific instructions.

​
Request Example

Boleto
curl --location 'https://api.sandbox.wepayout.co/v2/payin/payments' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_TOKEN_HERE' \
--data-raw '{
  "payment_method": "boleto",
  "invoice": "YOUR-INVOICE-CODE",
  "currency": "BRL",
  "amount": 500,
  "country": "BR",
  "buyer": {
    "name": "Buyer Name",
    "email": "buyer@example.com",
    "document": {
      "type": "CPF",
      "number": "12345678901"
    },
    "address": {
      "street": "Street Name",
      "number": "123",
      "zipcode": "12345000",
      "city": "City Name",
      "district": "District Name",
      "state_code": "SP"
    }
  },
  "originator_legal_entity": {
    "name": "Company Name",
    "document": "12345678901",
    "helpdesk": "company.com"
  },
  "boleto": {
    "expire_date": "2025-12-31"
  }
}'

​
Response

​
id
integer
WEpayments auto generated id, use this id to perform conciliation or perform queries via API / Dashboard.
​
merchant
object
Merchant object.
​
hash
string
WEpayments auto generated hash, use this hash to send your user to the payment page.
​
payment_page
string
The WEpayments payment page where you can redirect the end customer.
​
our_number
string
The bank identification number.
​
invoice
string
Your identification number.
​
notification_url
string
The url where callbacks are submitted.
​
payment_method
string
Payment method used in payin.Value: boleto
​
amount
integer
The payin total amount in cents.
​
paid_amount
integer
The total amount of the payin paid.
​
refunded_amount
integer
Amount refunded from this charge.
​
currency
object
Currency object.
​
description
string
Instructions displayed to the user.
​
buyer
object
The person you are charging object.
​
originator_legal_entity
object
Final beneficiary object.
​
boleto
object
Boleto specific instructions object.
​
status
object
Status object.
​
status_history
array
Status history object.
​
substatus
object
Substatus object. Can be null.
​
refunds
array
Refund object list.
​
created_at
string
Cash-in created date.
​
updated_at
string
Cash-in update date.

​
Response Example

201 Bank Slip
{
  "id": 54830,
  "merchant": {
    "id": 512,
    "name": "Acme Sandbox Store"
  },
  "hash": "9c8d7e6f5a4b3c2f8b4d3c2e1a9a7d6c5f4e3a2b1c0d9e8f7a6b5c4d3e2f1a0",
  "payment_page": "https://pagar.sandbox.goboleto.com/?hash=9c8d7e6f5a4b3c2f8b4d3c2e1a9a7d6c5f4e3a2b1c0d9e8f7a6b5c4d3e2f1a0",
  "our_number": "991777551234",
  "invoice": "f3a9b1d4-8a11-4d99-b9cd-1234567890ab",
  "notification_url": null,
  "payment_method": "boleto",
  "amount": 500,
  "paid_amount": null,
  "refunded_amount": null,
  "currency": {
    "id": 19,
    "name": "Reais",
    "code": "BRL",
    "symbol": "R$"
  },
  "description": "",
  "created_at": "2026-04-30T12:20:39.000000Z",
  "updated_at": "2026-04-30T12:20:39.000000Z",
  "buyer": {
    "name": "Maria Souza",
    "email": "maria.souza@example.com",
    "document": {
      "type": "cpf",
      "number": "12345678909"
    },
    "address": {
      "country": "BR",
      "city": "Barueri",
      "street": "Alameda Rio Azul",
      "number": "500",
      "complement": "Bloco B Sala 1503",
      "zipcode": "06454000",
      "district": "Alphaville Industrial",
      "state_code": "SP"
    }
  },
  "originator_legal_entity": {
    "name": "North Pole Commerce",
    "document": "10987654321",
    "helpdesk": "support.northpole.example"
  },
  "splits": [],
  "boleto": {
    "expire_date": "2027-12-31",
    "digitable_line": "10499.63208 34000.100049 66666.344205 1 81490000000200",
    "bar_code_number": "10491814900000002009632034000900041179634666",
    "agreement": {
      "number": "666666",
      "digit": "6",
      "agency": "9999",
      "assignor_code": "9999/666666-6"
    },
    "fine": {
      "percent": 2,
      "amount": 10,
      "date": "2027-12-30"
    },
    "discount": {
      "percent": null,
      "amount": null,
      "daily_amount": null,
      "date": null
    }
  },
  "status": {
    "id": 1,
    "name": "Created"
  },
  "status_history": [
    {
      "status": {
        "id": 1,
        "name": "Created"
      },
      "updated_at": "2026-04-30T12:20:39.000000Z"
    }
  ],
  "substatus": null,
  "refunds": [],
  "automatic_pix": null
}

Create Charge (Pix)

Use the same endpoint with pix-specific required fields

Get Unique Charge

Retrieve a specific charge by ID