POST /payments/requests
Create a payment requestServers
- https://api.brevo.com/v3
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
description |
String | No |
Description of payment request. |
configuration |
No |
Optional. Redirect contact to a custom success page once payment is successful. If empty the default Brevo page will be displayed once a payment is validated |
|
notification |
Object | No |
Optional. Use this object if you want to let Brevo send an email to the contact, with the payment request URL. If empty, no notifications (message and reminders) will be sent. |
notification.channel |
String | Yes |
Channel used to send the notifications. Valid values:
|
notification.text |
String | Yes |
Use this field if you want to give more context to your contact about the payment request. |
cart |
Object | Yes |
Specify the payment currency and amount. |
cart.currency |
String | Yes |
Currency code for the payment amount. Valid values:
|
cart.specificAmount |
Integer | Yes |
Payment amount, in cents. e.g. if you want to request €12.00, then the amount in cents is 1200. |
reference |
String | Yes |
Reference of the payment request, it will appear on the payment page. |
contactId |
Integer | Yes |
Brevo ID of the contact requested to pay. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.