Payments

Get payment request details

Changed on
get/payments/requests/{id}

Request

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

Path parameters

idstring required

Id of the payment Request

Response

Payment request details

referencestring required

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

status'created' | 'sent' | 'reminderSent - paid' required

Status of the payment request.

contactIdinteger

Brevo ID of the contact requested to pay.

numberOfRemindersSentinteger

number of reminders sent.

Example response

{
  "reference": "Invoice #INV0001\n",
  "notification": {
    "channel": "email",
    "text": "Please pay for your yoga class."
  },
  "configuration": {
    "customSuccessUrl": "https://my-company.com/payment-success"
  },
  "contactId": 43,
  "cart": {
    "specificAmount": 1200,
    "currency": "EUR"
  },
  "status": "paid",
  "numberOfRemindersSent": 5
}

Changes