Payment webhooks | Brevo API Documentation

In this page you find the currently supported payment events and their respective payload.

Payment authorized

Attribute	Datatype	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`

Following are other inner nodes of the payment_done event payload describing products, buyer_information, billing_information and shipping_information.

Products information

Attribute	Datatype	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 that has the parameters mentioned below.

Attribute	Datatype	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, the attributes for them are mentioned below in tables.

Attribute	Datatype	Description
`email`	String	Email of the buyer

Billing information
It defines the billing address and details.

Attribute	Datatype	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
It defines the information where the order is to be shipped.

Attribute	Datatype	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

1 {
2   "id": 739816,
3   "event_name": "payment_done",
4   "date": "2023-03-09T14:06:58.005Z",
5   "type": "payment_link",
6   "name": "Test release 09/03",
7   "url": "https://pay.brevo.com/377a9c15-d063-49f2-bb72-2b5567b735da",
8   "total_amount": {
9     "currency": "EUR",
10     "amount": 1
11   },
12   "products": [
13     {
14       "name": "Article 1",
15       "quantity": 1,
16       "unit_prices": {
17         "currency": "EUR",
18         "price_before_tax": 0.83,
19         "tax_rate": 20,
20         "price_including_tax": 1
21       }
22     }
23   ],
24   "buyer_information": {
25     "email": "alexandre.hudavert@gmail.com",
26     "billing_information": {
27       "name": "Alexandre Hudavert",
28       "street": "Rue Louis Blanc",
29       "number": "61",
30       "zip_code": "75010",
31       "city": "Paris",
32       "country": "France"
33     },
34   "shipping_information": {
35     "name": "Hudavert",
36     "street": "Rue de Madrid",
37     "number": "7",
38     "zip_code": "75008",
39     "city": "Paris",
40     "country": "France"
41     }
42  }
43 }

Payment link created (soon to be supported)

Attribute	Datatype	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	Datatype	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