Generated by API Evangelist
Written by API Evangelist tooling for Brevo's API. It is a proposal applied on top of the contract, not a document Brevo publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Ecommerce Payments API
version: 1.0.0
extends: openapi/brevo-payments-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 3
- target: $.paths['/payments/requests'].post
update:
x-apievangelist-phrasing:
intent: Request a payment from a contact
effect: write
questions:
- How do I send a contact a link to pay me?
- Is the payment amount given in cents, and which currency is used?
instructions:
- text: Create a payment request {reference} for contact {contactId} with cart {cart}.
slots:
reference: requestBody.reference
contactId: requestBody.contactId
cart: requestBody.cart
- text: Bill contact {contactId} for {cart} with reference {reference} and description {description}.
slots:
contactId: requestBody.contactId
cart: requestBody.cart
reference: requestBody.reference
description: requestBody.description
method: generated
generated: '2026-09-26'
- target: $.paths['/payments/requests/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get a payment request
effect: read
questions:
- Has a contact paid the payment request I sent?
- Can I check whether a reminder was sent for a payment request?
instructions:
- text: Show payment request {id}.
slots:
id: path.id
- text: Check the status of payment request {id}.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/payments/requests/{id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a payment request
effect: destructive
questions:
- Can I cancel a payment request so it can no longer be paid?
- What happens if I delete a payment request that doesn't exist?
instructions:
- text: Delete payment request {id}.
slots:
id: path.id
- text: Withdraw payment request {id} so it can't be paid.
slots:
id: path.id
method: generated
generated: '2026-09-26'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.