Skip to main content
POST
Create a legacy Flutterwave payment plan checkout

Path Parameters

client_id
integer
required

Client id used for currency, client/subaccount lookup, and transaction reference generation.

program_id
integer
required

Program id used for redirect URL and logging context.

session_id
string
required

Redis frontend session id containing saved_entity_id and saved_entity_frequency. Current code throws an error when it is omitted.

Body

application/json

Legacy Flutterwave checkout payload. Optional sponsorship availability and fixed-level amount selections are validated before provider checkout creation. Email and entity_id are used downstream.

email
string<email>
required

Customer email sent to Flutterwave checkout.

Example:

"jane@example.org"

entity_id
integer
required

Entity id used in redirect URL and Flutterwave metadata.

Example:

4711

Response

Flutterwave checkout was created.

status
string
Example:

"success"

message
string | null
data
object | null

Provider checkout payload, commonly including a hosted payment link.

transaction_reference
string
Example:

"TX-207-645abc-1715000000"