Boleto

Understand the delayed Boleto payment reminder event.

The significance of the Boleto payload in the delayed_payment.reminder request 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 numeric identifier for the Boleto, used by the shopper 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.

Boleto payload example

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

A delayed_payment.reminder event is triggered when a customer places an order using Boleto as their payment method but has not yet completed it. This process ensures that transactions are completed on time and informs customers of their pending payment obligations. The reminder includes essential details specific to the Boleto payment method, ensuring the customer has all the necessary information to finalize the payment.

Key components of the request:

• type: Identifies the request as a reminder for a delayed payment (delayed_payment.reminder).

• boletoBancario:

  • documentCode: A critical URL linking to the Boleto document, facilitating payment processing.

  • document: The numeric identifier aiding in the completion of the payment via banking apps.

  Example Payload:

  {
    "type": "delayed_payment.reminder",
    "data": {
      "boletoBancario": {
        "documentCode": "23793381286007047838725000526100688270000009900",
        "document": "{documentUrl}"
      },
      ...
    },
    ...
  }

  This reminder is pivotal in reducing payment delays or defaults by keeping shoppers informed, aiding in a smoother transaction flow, and recovering potentially lost revenue.

Webhook payload

{
  "type": "delayed_payment.reminder",
  "data": {
    "object": {
      "orderId": "1032713644439",
      "placedOnDate": "2021-11-24T16:32:07.000Z",
      "products": [
        {
          "id": "5325101400",
          "externalReferenceId": "5325101400",
          "displayName": "Acme Security software",
          "sku": "PRW-00-001-12"
        }
      ],
      "billToAddress": {
        "firstName": "Jane",
        "lastName": "Doe",
        "line1": "line1",
        "line2": "line2",
        "city": "Sao Paulo",
        "postalCode": "09320-070",
        "state": "SP",
        "country": "BR",
        "countryName": "Brasil",
        "phoneNumber": "5552253720",
        "emailAddress": "[e-mail]"
      },
      "shipToAddress": {
        "firstName": "Jane",
        "lastName": "Doe",
        "line1": "line1",
        "line2": "line2",
        "city": "Sao Paulo",
        "postalCode": "09320-070",
        "state": "SP",
        "country": "BR",
        "countryName": "Brazil",
        "phoneNumber": "5552253720",
        "emailAddress": "[e-mail]"
      },
      "shopperId": "550619489112"",
      "locale": "pt_BR",
      "siteId": "acmeco",
      "orderTotal": 99,
      "currency": "BRL",
      "orderDiscount": 0,
      "subTotal": 86.97,
      "tax": 12.03,
      "shippingTotal": 0,
      "businessEntity": "Digital River Brazil",
      "paymentSourceType": "boletoBancario",
      "boletoBancario": {
        "documentCode": "23793381286007047838725000526100688270000009900",
        "document": "{documentUrl}"
      }
    }
  },
  "clientIds": {
    "site_id": "acmebr"
  },
  "searchableData": {
    "orderId": "1032713644439"
  }
}