Skip to navigation
EcommercePayments

Create a payment request

View as Markdown

Create a new payment request for a Brevo contact. The request requires a reference (displayed on the payment page), a contact ID, and a cart with currency and amount in cents. You can optionally configure a custom success redirect URL and enable email notifications with reminders. Returns the payment request ID and its public payment URL. A 403 error is returned if Brevo Payments is not activated or the account is not validated.

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

OR
AuthorizationBearer

OAuth 2.0 client_credentials (machine-to-machine) grant. Exchange your app’s client_id/client_secret for a short-lived Bearer token.

Request

Create a payment request
cartobjectRequired
Specify the payment currency and amount.
contactIdlongRequired
Brevo ID of the contact requested to pay.
referencestringRequired
Reference of the payment request, it will appear on the payment page.
configurationobjectOptional
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
descriptionstringOptional
Description of payment request.
notificationobjectOptional

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.

Response

Payment request created.
idlong
ID of the object created
urlstringOptional
URL of the payment request created

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error