# Bank Slip — Brazil

<img height="130" width="206" alt="boleto logo" title="boleto logo" src="https://static-devportal-ux.sensedia-eng.com/Pagonxt/staging/documentations/download-1-1768836401511-ix3fkdw7.png" />

The **Bank Slip** (Boleto Bancário) is one of the most widely used cash-based payment methods in Brazil. This dedicated endpoint registers a "Boleto Registrado" with Santander, providing a digital line and barcode that customers can pay via banking applications, ATMs, or authorized lottery shops.

## Requirements

* **Authentication:** Provide a **Bearer Token** in the request header.
* **Registration:** All bank slips are registered in real-time with the interbank clearinghouse.
* **Seller Identification:** Ensure your credentials are correctly configured to route settlements to your account.

## Characteristics

| Capability | Details |
| :--- | :--- |
| **Customer Experience** | **Delayed** — Customer completes payment using the typeful line or barcode. |
| **Settlement** | **T+1 to T+3** — Funds typically settle within 1 to 3 business days. |
| **Confirmation** | **Asynchronous** — You must use webhooks to receive payment status updates. |

## Available Features

| Payment Flow | Supported Countries | Purchases | Refunds | Partial Refunds |
| :--- | :--- | :---: | :---: | :---: |
| Dedicated API | Brazil (BR) | ✅ | ✅ | ✅ |

## Integration Flow

Integrating the bank slip involves generating the payment data and listening for the interbank clearing process to notify your system via a webhook.

![diagram ](https://static-devportal-ux.sensedia-eng.com/Pagonxt/staging/documentations/boleto-diagram-1768243394915-n9t5d8ee.png)

### 1. Create the Bank Slip Request

Call the [Bank Slip endpoint](https://api.pre.globalgetnet.com/dpm/payments-gwproxy/v2/payments/boleto) to register the transaction. Ensure all required objects—`order`, `customer`, and `boleto`—are included within the `data` object as shown below.

```bash
curl --location --request POST 'https://api.pre.globalgetnet.com/dpm/payments-gwproxy/v2/payments/boleto' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <YOUR_TOKEN>' \
--data-raw '{
    "idempotency_key": "63c7f8ee-51a6-470d-bb76-ef762b62bfb7",
    "request_id": "daac03dc-73db-453f-9bea-b1391669d5d3",
    "data": {
        "amount": 1200,
        "payment": {
            "payment_id": "e9595164-deaa-4341-bb37-b4b9c570a6d3",
            "payment_method": "BOLETO"
        },
        "currency": "BRL",
        "order": {
            "order_id": "6d2e4380-d8a3-4ccb-9138-c289182818a3",
            "sales_tax": 12,
            "product_type": "service"
        },
        "boleto": {
            "our_number": "19465999",
            "document_number": "34602387802",
            "expiration_date": "16/11/2030",
            "instructions": "Não receber após o vencimento",
            "provider": "santander",
            "guarantor_name": "Jose Filho",
            "guarantor_document_type": "CPF",
            "guarantor_document_number": "34602387802"
        },
        "customer": {
            "first_name": "Jose",
            "last_name": "Filho",
            "name": "Jose Filho",
            "document_type": "CPF",
            "phone_number": "5511955554444",
            "email": "joaodasilva@dominio.com",
            "document_number": "34602387802",
            "billing_address": {
                "street": "Av. Brasil",
                "number": "1000",
                "complement": "Sala 1",
                "district": "São Geraldo",
                "city": "Porto Alegre",
                "state": "RS",
                "postal_code": "90230060"
            }
        }
    }
}'
```

### 2. Handle the Response

A successful registration returns a `201 Created` status. The response contains the `typeful_line` and `bar_code` required for the customer to complete the payment.

<Callout type="note">

Provide the `typeful_line` for "Copy and Paste" functionality on mobile devices and use the `bar_code` for rendering the physical barcode graphic.

</Callout>

```json
{
  "payment_id": "e9595164-deaa-4341-bb37-b4b9c570a6d3",
  "status": "PENDING",
  "boleto": {
    "status_label": "EM ABERTO",
    "typeful_line": "03399.08063 73400.000208 60238.780205 1 84320000001200",
    "bar_code": "03391843200000012000806373400000206023878020",
    "expiration_date": "16/11/2030",
    "bank": "033",
    "payment_place": "PAGAR PREFERENCIALMENTE EM UMA AGENCIA DO BANCO SANTANDER S.A."
  }
}
```

## Post-Sale Operations

### Webhook Confirmation

Since bank slip clearing takes 1–3 business days, do not release products or services immediately. Configure your system to listen for the `PAYMENT_APPROVED` event at your registered `callback_url` to confirm the transaction.

### Refunds

Refunds are supported. To process a refund, the merchant must typically collect the customer's bank account details (Bank, Agency, Account Number) to perform a TED transfer, as the funds do not automatically return to the source account.