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

# Create Charge (Bank Slip)

Generate a new Boleto payment request.

## Request Body

<ParamField body="merchant_id" type="integer">
  Merchant id of the account that is creating the payin. Mandatory if there is more than one account under your umbrella (sellers).
</ParamField>

<ParamField body="invoice" type="string" required>
  Your identification number, it must be unique on our database.
</ParamField>

<ParamField body="notification_url" type="string">
  The url where we will submit the callbacks.
</ParamField>

<ParamField body="payment_method" type="string" required>
  Payment method that will be used in payin.

  Allowed value: `boleto`
</ParamField>

<ParamField body="amount" type="integer" required>
  The charge total amount in the smallest currency unit.

  Min: `500`
</ParamField>

<ParamField body="currency" type="string" required>
  Currency code of the amount (ISO 4217). Example: `BRL`
</ParamField>

<ParamField body="country" type="string" required>
  Country code (ISO 3166-1 alpha-2). Example: `BR`
</ParamField>

<ParamField body="description" type="string">
  Instructions that will be displayed to the user.
</ParamField>

<ParamField body="buyer" type="object" required>
  The person you are charging object.

  <Expandable title="Buyer Object">
    <ParamField body="name" type="string" required>
      The buyer name.
    </ParamField>

    <ParamField body="email" type="string" required>
      Buyer email address.
    </ParamField>

    <ParamField body="document" type="object" required>
      The buyer document.

      <Expandable title="Document Object">
        <ParamField body="type" type="string" required>
          Document type. Example: `CPF`, `CNPJ`
        </ParamField>

        <ParamField body="number" type="string" required>
          Document number.
        </ParamField>
      </Expandable>
    </ParamField>

    <ParamField body="address" type="object" required>
      The buyer's address.

      <Expandable title="Address Object">
        <ParamField body="street" type="string" required>
          Street name.
        </ParamField>

        <ParamField body="number" type="string" required>
          Street number.
        </ParamField>

        <ParamField body="zipcode" type="string" required>
          ZIP/Postal code.
        </ParamField>

        <ParamField body="city" type="string" required>
          City name.
        </ParamField>

        <ParamField body="district" type="string" required>
          District/Neighborhood.
        </ParamField>

        <ParamField body="state_code" type="string" required>
          State code.
        </ParamField>
      </Expandable>
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="originator_legal_entity" type="object" required>
  Use this object to inform the legal name of the final beneficiary.
</ParamField>

<ParamField body="boleto" type="object" required>
  Boleto specific instructions.

  <Expandable title="Boleto Object">
    <ParamField body="expire_date" type="string" required>
      The payin expiration date. Format: `YYYY-MM-DD`
    </ParamField>
  </Expandable>
</ParamField>

## Request Example

```bash Boleto theme={null}
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

<ResponseField name="id" type="integer">
  WEpayments auto generated id, use this id to perform conciliation or perform queries via API / Dashboard.
</ResponseField>

<ResponseField name="merchant" type="object">
  Merchant object.

  <Expandable title="Merchant">
    <ResponseField name="id" type="integer">
      Id of the WE account that created the payin.
    </ResponseField>

    <ResponseField name="name" type="string">
      Name of the WE account that created the payin.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="hash" type="string">
  WEpayments auto generated hash, use this hash to send your user to the payment page.
</ResponseField>

<ResponseField name="payment_page" type="string">
  The WEpayments payment page where you can redirect the end customer.
</ResponseField>

<ResponseField name="our_number" type="string">
  The bank identification number.
</ResponseField>

<ResponseField name="invoice" type="string">
  Your identification number.
</ResponseField>

<ResponseField name="notification_url" type="string">
  The url where callbacks are submitted.
</ResponseField>

<ResponseField name="payment_method" type="string">
  Payment method used in payin.

  Value: `boleto`
</ResponseField>

<ResponseField name="amount" type="integer">
  The payin total amount in cents.
</ResponseField>

<ResponseField name="paid_amount" type="integer">
  The total amount of the payin paid.
</ResponseField>

<ResponseField name="refunded_amount" type="integer">
  Amount refunded from this charge.
</ResponseField>

<ResponseField name="currency" type="object">
  Currency object.

  <Expandable title="Currency">
    <ResponseField name="id" type="integer">
      Currency id.
    </ResponseField>

    <ResponseField name="name" type="string">
      Currency name.
    </ResponseField>

    <ResponseField name="code" type="string">
      Currency code (ISO 4217).
    </ResponseField>

    <ResponseField name="symbol" type="string">
      Currency symbol.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="description" type="string">
  Instructions displayed to the user.
</ResponseField>

<ResponseField name="buyer" type="object">
  The person you are charging object.
</ResponseField>

<ResponseField name="originator_legal_entity" type="object">
  Final beneficiary object.
</ResponseField>

<ResponseField name="boleto" type="object">
  Boleto specific instructions object.

  <Expandable title="Boleto Response">
    <ResponseField name="expire_date" type="string">
      Expiration date in format `YYYY-MM-DD`.
    </ResponseField>

    <ResponseField name="digitable_line" type="string">
      Digitable line for boleto payment.
    </ResponseField>

    <ResponseField name="bar_code_number" type="string">
      Barcode number for boleto.
    </ResponseField>

    <ResponseField name="agreement" type="object">
      Extra data for boleto rendering.
    </ResponseField>

    <ResponseField name="fine" type="object">
      Fine object.
    </ResponseField>

    <ResponseField name="discount" type="object">
      Discount object.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="status" type="object">
  Status object.

  <Expandable title="Status">
    <ResponseField name="id" type="integer">
      Status id.
    </ResponseField>

    <ResponseField name="name" type="string">
      Status name.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="status_history" type="array">
  Status history object.
</ResponseField>

<ResponseField name="substatus" type="object">
  Substatus object. Can be null.
</ResponseField>

<ResponseField name="refunds" type="array">
  Refund object list.
</ResponseField>

<ResponseField name="created_at" type="string">
  Cash-in created date.
</ResponseField>

<ResponseField name="updated_at" type="string">
  Cash-in update date.
</ResponseField>

## Response Example

```json 201 Bank Slip theme={null}
{
  "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
}
```

## Related Resources

<CardGroup cols={2}>
  <Card title="Create Charge (Pix)" icon="qrcode" href="/api-reference/cash-in/payin/create-charge-pix">
    Use the same endpoint with pix-specific required fields
  </Card>

  <Card title="Get Unique Charge" icon="magnifying-glass" href="/api-reference/cash-in/payin/get-unique-charge">
    Retrieve a specific charge by ID
  </Card>
</CardGroup>