# Boleto

The significance of the Boleto payload in the `delayed_payment.expired` requests lies in its role in facilitating the identification and reminder process for pending or expired payments made through the Boleto payment method. Specifically, the Boleto payload includes critical details such as:

* **`documentCode`**: A URL linking to the Boleto document code is essential for payment processing.
* **`document`**: The shopper uses the numeric identifier for the Boleto to complete the payment via a banking application.

These elements are crucial for reminding shoppers of outstanding payments, processing expired payments, ensuring a smooth transaction flow, and recovering potentially lost revenue.

{% tabs %}
{% tab title="Boleto payload example" %}

```http
"boletoBancario": {
        "documentCode",
        "document"
}
```

{% endtab %}
{% endtabs %}

The `delayed_payment.expired` event is a critical event in the lifecycle of payments made through the Boleto payment method. This request is generated when the allocated timeframe for completing payment via Boleto has elapsed without receiving the necessary funds. It indicates that the order associated with the payment has expired due to non-completion within the designated period.

**Key Components:**

* **type**: Specifies the request type as `delayed_payment.expired`.
* **data**: Contains detailed information about the expired payment order, including:
  * **object**:

    * **orderId**: Unique identifier for the expired order.
    * **placedOnDate**: Timestamp indicating when the order was placed.
    * **products**: Details each product included in the order.
    * **billToAddress & shipToAddress**: Customer and shipping information.
    * **shopperId**: Unique identifier for the shopper.
    * **locale**: Shopper's locale setting.
    * **siteId**: Identifier for the site where the order was placed.
    * **orderTotal**: Total amount of the order.
    * **currency**: Transaction currency.
    * **orderDiscount**: The discounts applied to the order.
    * **subTotal**: Subtotal amount before taxes.
    * **tax**: Applicable tax amount.
    * **shippingTotal**: Total shipping cost.
    * **businessEntity**: The entity handling the order, here `"Digital River Brazil"`.
    * **expirationDate**: The date and time when the payment option expires.
    * **expirationDays**: Number of days to expiration from order placement.
    * **paymentSourceType**: The method of payment is indicated as boletoBancario.
    * **boletoBancario**: Specific information about the Boleto payment.

    This event ensures that orders and payments are tracked effectively from initiation to expiration, allowing for appropriate actions such as customer notifications or order cancellations in the event of an unsuccessful transaction.

{% tabs %}
{% tab title="Request" %}

```json
{
   "type":"delayed_payment.expired",
   "data":{
      "object":{
         "orderId":"1004717881620",
         "placedOnDate":"2022-05-31T09:14:18.000Z",
         "products":[
            {
               "id":"5530211800",
               "externalReferenceId":"900800101",
               "displayName":"PPRO E2E Digital Image",
               "sku":"900800101"
            }
         ],
         "billToAddress":{
            "firstName":"Guilherme",
            "lastName":"Miranda",
            "line1":"1000 Avenida Paulista",
            "city":"Bela Vista",
            "postalCode":"01310-100",
            "state":"SP",
            "country":"BR",
            "countryName":"Brazil",
            "phoneNumber":"5531986463859",
            "emailAddress":"guizinutesti@gmail.com"
         },
         "shipToAddress":{
            "firstName":"Guilherme",
            "lastName":"Miranda",
            "line1":"1000 Avenida Paulista",
            "city":"Bela Vista",
            "postalCode":"01310-100",
            "state":"SP",
            "country":"BR",
            "countryName":"Brazil",
            "phoneNumber":"5531986463859",
            "emailAddress":"guizinutesti@gmail.com"
         },
         "shopperId":"514650873010",
         "locale":"pt_BR",
         "siteId":"paylive",
         "orderTotal":29.94,
         "currency":"BRL",
         "orderDiscount":0.0,
         "subTotal":26.3,
         "tax":3.64,
         "shippingTotal":0.0,
         "businessEntity":"Digital River Brazil",
         "expirationDate":"2022-06-30T09:05:05.000Z",
         "expirationDays":30,
         "paymentSourceType":"boletoBancario",
         "boletoBancario":{
            "documentCode":"23793381286006844671926000526108487940000002994",
            "document":"https://meiosdepagamentobradesco.com.br/apiboleto/Bradesco?token=QjdnVkh6YUZBODhMcVJZeFUvQ2RMbVVFSHY4azhOa1JiRlRNQW9teUFkSFpaU2hLeDUxU2NqVG5taER6R3BJcQ.."
         }
      }
   },
   "clientIds":{
      "site_id":"paylive"
   },
   "searchableData":{
      "orderId":"1004717881620"
   }
}
```

{% endtab %}
{% endtabs %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.digitalriver.com/commerce-api/events/event-types/delayed-payment-event-types/delayed-payment-expired-event/boleto.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
