How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Brevo Payments API

The payments API from Brevo — 2 operation(s) for payments.

Brevo Payments API is one of 53 APIs that Brevo publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Payments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 3 operations across 2 paths, and defines 17 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://api.brevo.com/v3.

3 operations 2 paths 17 schemas 1 DELETE1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.brevo.com/v3
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Brevo Payments API declares 1 security scheme for authenticating requests. An API key is passed in the header as api-key (api-key).

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

Paths & Operations 3

Across 2 paths, the API surfaces 3 operations — 1 DELETE, 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

payments 3
POST
/payments/requests
Create a payment request
createPaymentRequest 1 param body → 201400401403
GET
/payments/requests/{id}
Get payment request details
getPaymentRequest 2 params → 200400401403404
DELETE
/payments/requests/{id}
Delete a payment request.
deletePaymentRequest 2 params → 204401403404

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are Payments_getPaymentRequest_Response_200 (7 properties), errorModel (2 properties), CreatePaymentRequestRequestBadRequestError (2 properties), notification (2 properties). Each schema is shown below with its type and property counts.

NotificationChannel
string
Channel used to send the notifications.
Payments_getPaymentRequest_Response_200
object
7 properties 4 required
DeletePaymentRequestRequestUnauthorizedError
object
2 properties 2 required
cart
object
Specify the payment currency and amount.
2 properties 2 required
CartCurrency
string
Currency code for the payment amount.
Payments_createPaymentRequest_Response_201
object
2 properties 1 required
PaymentsRequestsIdGetResponsesContentApplicationJsonSchemaStatus
string
Status of the payment request.
PaymentsRequestsIdGetResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
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 reminder…
2 properties 2 required
PaymentsRequestsPostResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
CreatePaymentRequestRequestBadRequestError
object
2 properties 2 required
errorModel
object
2 properties 1 required
GetPaymentRequestRequestUnauthorizedError
object
2 properties 2 required
GetPaymentRequestRequestBadRequestError
object
2 properties 2 required
PaymentsRequestsIdDeleteResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
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
1 property 1 required
CreatePaymentRequestRequestUnauthorizedError
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

brevo-payments-api-openapi.yml Raw ↑

Other APIs Brevo publishes across the network.

brevo Agent Status API
brevo Automated Messages API
brevo Campaign Statistics API
brevo Categories API
brevo Contact Attributes API
brevo Contact Lists API
brevo Contacts API
brevo Email Activity API
brevo Email Campaigns API
brevo Email Templates API
brevo Folders API
brevo Import API
Where this information came from

This is an independent, third-party profile of Brevo Payments API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.