Create an order

post

https://developersandbox-api.flutterwave.com/orders

Create an order

Body Params

amount

number

required

≥ 0.01

The payment amount in decimals.

currency

string

enum

required

ISO 4217 currency code.

reference

string

required

length between 6 and 42

A custom identifier to track the transaction, This must be unique across all your transactions.

customer_id

string

required

ID of the customer.

meta

object

payment_method_id

string

required

ID of the payment method.

redirect_url

string

Specifies the URL to redirect to.

authorization

merchant_vat_amount

number

Headers

X-Trace-Id

string

length between 12 and 255

A unique identifier to track this operation. It must be between 12 and 255 characters in length.

X-Idempotency-Key

string

length between 12 and 255

A unique identifier to prevent duplicate requests. It must be between 12 and 255 characters in length.

X-Scenario-Key

string

1 to 1000

An optional scenario key that can be used to simulate specific behaviors or test different scenarios within the API. Providing this header allows you to trigger predefined responses or alter data based on the key's value, which can be useful for testing, development, or demonstrating specific functionalities. The key should be a string of 1 to 1000 characters.

Responses

201OK

400Bad request

401Unauthorised request

403Forbidden

409Conflict