Create a Payout Subaccount

curl --request POST \
  --url https://api.flutterwave.com/v3/payout-subaccounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_name": "john doe",
  "email": "johndoe@gmail.com",
  "mobilenumber": "09010000000",
  "country": "NG"
}
'

import requests

url = "https://api.flutterwave.com/v3/payout-subaccounts"

payload = {
    "account_name": "john doe",
    "email": "johndoe@gmail.com",
    "mobilenumber": "09010000000",
    "country": "NG"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    account_name: 'john doe',
    email: 'johndoe@gmail.com',
    mobilenumber: '09010000000',
    country: 'NG'
  })
};

fetch('https://api.flutterwave.com/v3/payout-subaccounts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.flutterwave.com/v3/payout-subaccounts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'account_name' => 'john doe',
    'email' => 'johndoe@gmail.com',
    'mobilenumber' => '09010000000',
    'country' => 'NG'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.flutterwave.com/v3/payout-subaccounts"

	payload := strings.NewReader("{\n  \"account_name\": \"john doe\",\n  \"email\": \"johndoe@gmail.com\",\n  \"mobilenumber\": \"09010000000\",\n  \"country\": \"NG\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.flutterwave.com/v3/payout-subaccounts")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"account_name\": \"john doe\",\n  \"email\": \"johndoe@gmail.com\",\n  \"mobilenumber\": \"09010000000\",\n  \"country\": \"NG\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.flutterwave.com/v3/payout-subaccounts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"account_name\": \"john doe\",\n  \"email\": \"johndoe@gmail.com\",\n  \"mobilenumber\": \"09010000000\",\n  \"country\": \"NG\"\n}"

response = http.request(request)
puts response.read_body

{
  "status": "success",
  "message": "Payout subaccount created",
  "data": {
    "id": 4190,
    "account_reference": "PSA7472870CFA3073543",
    "account_name": "Example User",
    "barter_id": "234000002466747",
    "email": "user@gmail.com",
    "mobilenumber": "09010000000",
    "country": "US",
    "nuban": "6222125542",
    "bank_name": "Sterling Bank",
    "bank_code": "232",
    "status": "ACTIVE",
    "created_at": "2024-03-24T09:38:03.000Z"
  }
}

{
  "status": "error",
  "message": "Email already exists",
  "data": null
}

POST

payout-subaccounts

Create a Payout Subaccount

curl --request POST \
  --url https://api.flutterwave.com/v3/payout-subaccounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_name": "john doe",
  "email": "johndoe@gmail.com",
  "mobilenumber": "09010000000",
  "country": "NG"
}
'

import requests

url = "https://api.flutterwave.com/v3/payout-subaccounts"

payload = {
    "account_name": "john doe",
    "email": "johndoe@gmail.com",
    "mobilenumber": "09010000000",
    "country": "NG"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    account_name: 'john doe',
    email: 'johndoe@gmail.com',
    mobilenumber: '09010000000',
    country: 'NG'
  })
};

fetch('https://api.flutterwave.com/v3/payout-subaccounts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.flutterwave.com/v3/payout-subaccounts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'account_name' => 'john doe',
    'email' => 'johndoe@gmail.com',
    'mobilenumber' => '09010000000',
    'country' => 'NG'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.flutterwave.com/v3/payout-subaccounts"

	payload := strings.NewReader("{\n  \"account_name\": \"john doe\",\n  \"email\": \"johndoe@gmail.com\",\n  \"mobilenumber\": \"09010000000\",\n  \"country\": \"NG\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.flutterwave.com/v3/payout-subaccounts")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"account_name\": \"john doe\",\n  \"email\": \"johndoe@gmail.com\",\n  \"mobilenumber\": \"09010000000\",\n  \"country\": \"NG\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.flutterwave.com/v3/payout-subaccounts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"account_name\": \"john doe\",\n  \"email\": \"johndoe@gmail.com\",\n  \"mobilenumber\": \"09010000000\",\n  \"country\": \"NG\"\n}"

response = http.request(request)
puts response.read_body

{
  "status": "success",
  "message": "Payout subaccount created",
  "data": {
    "id": 4190,
    "account_reference": "PSA7472870CFA3073543",
    "account_name": "Example User",
    "barter_id": "234000002466747",
    "email": "user@gmail.com",
    "mobilenumber": "09010000000",
    "country": "US",
    "nuban": "6222125542",
    "bank_name": "Sterling Bank",
    "bank_code": "232",
    "status": "ACTIVE",
    "created_at": "2024-03-24T09:38:03.000Z"
  }
}

{
  "status": "error",
  "message": "Email already exists",
  "data": null
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

account_name

string

required

string

required

mobilenumber

string

required

country

string

required

Response

status

string

required

message

string

required

data

Data55 · object

required

Show child attributes

Example:

{
  "id": 4190,
  "account_reference": "PSA7472870CFA3073543",
  "account_name": "Example User",
  "barter_id": "234000002466747",
  "email": "user@gmail.com",
  "mobilenumber": "09010000000",
  "country": "US",
  "nuban": "6222125542",
  "bank_name": "Sterling Bank",
  "bank_code": "232",
  "status": "ACTIVE",
  "created_at": "2024-03-24T09:38:03.000Z"
}

API Documentation

Charges

Tokenized Charges

Preauthorization

Transactions

Transfers

Beneficiaries

Virtual Cards

Virtual Account Numbers

Collection Subaccounts

Payout Subaccounts

Subscriptions

Payment Plans

Bill Payments

Banks

Misc

Settlements

Otps

Chargebacks

Create a Payout Subaccount

Authorizations

Body

Response