Delete a payment request. | Brevo API Documentation

Delete a payment request by its UUID. Once deleted, the payment request can no longer be accessed or paid. Returns a 404 error if no payment request matches the provided ID, and a 403 error if Brevo Payments is not activated or the account is not validated.

Authentication

api-keystring

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

Path parameters

idstringRequiredformat: "uuid"

ID of the payment request.

Response

Payment request deleted successfully.

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

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

ID of the payment request.

Payment request deleted successfully.

1	import { BrevoClient } from "@getbrevo/brevo";
2
3	async function main() {
4	const client = new BrevoClient({
5	apiKey: "YOUR_API_KEY_HERE",
6	});
7	await client.payments.deletePaymentRequest("9ae7d68a-565c-4695-9381-d8fb3e3a14cc");
8	}
9	main();

1	import { BrevoClient } from "@getbrevo/brevo";
2
3	async function main() {
4	const client = new BrevoClient({
5	apiKey: "YOUR_API_KEY_HERE",
6	});
7	await client.payments.deletePaymentRequest("9ae7d68a-565c-4695-9381-d8fb3e3a14cc");
8	}
9	main();