> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://developers.brevo.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developers.brevo.com/_mcp/server.

# Payment webhooks

This page lists the currently supported payment events and their payloads.

* [Payment authorized](/docs/payment-webhooks#payment-authorized)
* [Payment not authorized (soon to be supported)](/docs/payment-webhooks#payment-not-authorized-soon-to-be-supported)
* [Payment link created (soon to be supported)](/docs/payment-webhooks#payment-link-created-soon-to-be-supported)

## Payment authorized

| Attribute      | Data type  | Description                                                                      |
| :------------- | :--------- | :------------------------------------------------------------------------------- |
| `id`           | Int64      | Id for the payment                                                               |
| `event_name`   | String     | `payment_done `                                                                  |
| `total_amount` | Array      | The total amount in the payment which has two sub-attributes currency and amount |
| `products`     | JSON Array | Array of distinct products                                                       |
| `url`          | String     | Path to the payment page                                                         |
| `name`         | String     | Name of the payment                                                              |
| `type`         | String     | There will be two types of payments, either `payment_link` or `payment_request`  |

\
\


The following inner nodes of the `payment_done` event payload describe `products`, `buyer_information`, `billing_information`, and `shipping_information`.

\


**Products information**

| Attribute     | Data type  | Description                                    |
| :------------ | :--------- | :--------------------------------------------- |
| `name`        | String     | Name of the product                            |
| `quantity`    | Int64      | Quantity of the product                        |
| `unit_prices` | JSON Array | Price of the unit including taxes and currency |

\


**Parameters for unit\_prices**\
`unit_prices` is a JSON array with the following parameters.

| Attribute                          | Data type | Description                        |
| :--------------------------------- | :-------- | :--------------------------------- |
| `unit_prices[currency]`            | String    | Exchange currency for the payment. |
| `unit_prices[price_before_tax]`    | float     | Price before taxes are included.   |
| `unit_prices[tax_rate]`            | float     | Tax rate for the product.          |
| `unit_prices[price_including_tax]` | float     | Price after including taxes.       |

\


**Buyer information**\
The `buyer_information` object includes `email`, `billing_information`, and `shipping_information`. Their attributes are listed in the tables below.

| Attribute | Data type | Description        |
| :-------- | :-------- | :----------------- |
| `email`   | String    | Email of the buyer |

\


**Billing information**\
The billing address and details.

| Attribute  | Data type | Description                                |
| :--------- | :-------- | :----------------------------------------- |
| `name`     | String    | Name of the buyer                          |
| `street`   | String    | Name of the street where the buyer resides |
| `number`   | String    | Street number                              |
| `zip_code` | String    | Zip code of the area                       |
| `city`     | String    | City where the buyer is residing           |
| `country`  | String    | Country of the buyer                       |

\


**Shipping information**\
Where the order is shipped.

| Attribute  | Data type | Description          |
| :--------- | :-------- | :------------------- |
| `name`     | String    | Name of the receiver |
| `street`   | String    | Street name          |
| `number`   | String    | Street number        |
| `zip_code` | String    | Zip code of the area |
| `city`     | String    | City of shipping     |
| `country`  | String    | Country of shipping  |

\


**Webhook payload sample**

```json
{
  "id": 739816,
  "event_name": "payment_done",
  "date": "2023-03-09T14:06:58.005Z",
  "type": "payment_link",
  "name": "Test release 09/03",
  "url": "https://pay.brevo.com/377a9c15-d063-49f2-bb72-2b5567b735da",
  "total_amount": {
    "currency": "EUR",
    "amount": 1
  },
  "products": [
    {
      "name": "Article 1",
      "quantity": 1,
      "unit_prices": {
        "currency": "EUR",
        "price_before_tax": 0.83,
        "tax_rate": 20,
        "price_including_tax": 1
      }
    }
  ],
  "buyer_information": {
    "email": "alexandre.hudavert@gmail.com",
    "billing_information": {
      "name": "Alexandre Hudavert",
      "street": "Rue Louis Blanc",
      "number": "61",
      "zip_code": "75010",
      "city": "Paris",
      "country": "France"
    },
  "shipping_information": {
    "name": "Hudavert",
    "street": "Rue de Madrid",
    "number": "7",
    "zip_code": "75008",
    "city": "Paris",
    "country": "France"
    }
 }
}
```

## Payment link created (soon to be supported)

| Attribute         | Data type | Description                       |
| :---------------- | :-------- | :-------------------------------- |
| `currency`        | String    | Exchange Currency for the payment |
| `products`        | Int64     | Array of distinct products        |
| `payment_link_id` | String    | Id for the payment link           |

## Payment not authorized (soon to be supported)

| Attribute         | Data type | Description                          |
| :---------------- | :-------- | :----------------------------------- |
| `event_name`      | String    | Name of the event                    |
| `total_amount`    | float     | The total amount in the payment      |
| `currency`        | String    | The exchange currency of the payment |
| `products`        | Int64     | Array of distinct products           |
| `payment_link_id` | String    | Id for the payment link              |
| `quantity`        | Int64     | Quantity of the products             |