API Reference

Create a payment request

post
https://api.brevo.com/v3/payments/requests
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Create a payment request

cart
object
required

Specify the payment currency and amount.

configuration
object

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

int64
required

Brevo ID of the contact requested to pay.

string

Description of payment request.

notification
object

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.

string
required

Reference of the payment request, it will appear on the payment page.

Responses

Updated about 2 years ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 years ago