Initiate an Orchestrator transfer.

post

https://developersandbox-api.flutterwave.com/direct-transfers

Create a transfer with Orchestrator helper.

Body Params

action

string

enum

required

To define whether the transfer should be processed immediately, scheduled for a later date, or deferred for future processing.

Allowed:

reference

string

length between 6 and 42

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

narration

string

length between 1 and 180

Transfer description. This cannot be greater than 180 characters.

disburse_option

object

To specify the date and time for disbursement, this is required when action is set to scheduled.

callback_url

string

Specify to set a callback url for receiving payout webhook, this will take precedent over the merchant's default webhook url.

meta

object

payment_instruction

required

Currency-specific information for the transfer.

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

Language

Credentials

Bearer

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201OK

400Bad request

401Unauthorised request

403Forbidden

409Conflict