Payments

Create a payment request

Changed on
post/payments/requests

Request

  • Base URL: https://api.brevo.com/v3
  • URL: https://api.brevo.com/v3/payments/requests
  • Auth: one of:
    • API key in header api-key
    • API key in header partner-key

Request body

referencestring required

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

contactIdinteger required

Brevo ID of the contact requested to pay.

descriptionstring

description of payment request.

Example request

{
  "reference": "Invoice #INV0001",
  "cart": {
    "specificAmount": 1200,
    "currency": "EUR"
  },
  "contactId": 43,
  "description": "Shipping Cost for sending bottles to NYC",
  "notification": {
    "channel": "email",
    "text": "Please pay for your yoga class."
  },
  "configuration": {
    "customSuccessUrl": "https://my-company.com/payment-success"
  }
}

Response

Payment request created.

idstring required

ID of the object created

urlstring

URL of the payment request created

Example response

{
  "id": "6d4ec0b2b48ef803df4103ve",
  "url": "https://pay.brevo.com/payment/6d4ec0b2b48ef803df4103ve"
}

Changes