DocumentationAPI ReferencesSupportBlogAsk AI
API References

Create a transfer

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

Creates a direct transfer using only the recipient and sender IDs. Before calling this endpoint, make sure you have already created both the recipient and the sender via their respective endpoints and obtained their IDs.

Body Params
string
enum
required

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

Allowed:
string
length between 6 and 42

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

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.

string

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

meta
object
payment_instruction
object
required
Headers
string
length between 12 and 255

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

string
length between 12 and 255

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

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

Updated 9 months ago

Language
Credentials
Bearer
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 9 months ago