List transfer recipients

curl --request GET \
  --url https://developersandbox-api.flutterwave.com/transfers/recipients \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://developersandbox-api.flutterwave.com/transfers/recipients"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://developersandbox-api.flutterwave.com/transfers/recipients', 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://developersandbox-api.flutterwave.com/transfers/recipients",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://developersandbox-api.flutterwave.com/transfers/recipients"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://developersandbox-api.flutterwave.com/transfers/recipients")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "message": "<string>",
  "data": {
    "cursor": {
      "next": "MjAyNC0xMS0yN1QxMjozMjozNC42MjBa",
      "previous": "MjAyNC0xMS0yOVQwMjoxMDo1My45OTla",
      "limit": 10,
      "total": 1000,
      "has_more_items": true
    },
    "recipients": [
      {
        "bank": {
          "account_number": "<string>",
          "code": "<string>",
          "branch": "<string>",
          "name": "<string>",
          "routing_number": "<string>",
          "swift_code": "<string>",
          "sort_code": "<string>"
        },
        "id": "<string>",
        "type": "bank",
        "name": {
          "first": "King",
          "middle": "Leo",
          "last": "LeBron"
        },
        "currency": "NGN",
        "national_identification": {
          "identifier": "FLY5869798686",
          "expiration_date": "2029-07-08"
        },
        "phone": {
          "country_code": "234",
          "number": "08012345678"
        },
        "date_of_birth": "<string>",
        "email": "hi@flutterwave.com",
        "address": {
          "city": "New York",
          "country": "US",
          "line1": "123 Main Street",
          "postal_code": "10001",
          "state": "New York",
          "line2": "Apt 4B"
        }
      }
    ]
  }
}

{
  "status": "failed",
  "error": {
    "type": "REQUEST_NOT_VALID",
    "code": "10400",
    "message": "Request is not valid",
    "validation_errors": [
      {
        "field_name": "amount",
        "message": "must not be null"
      }
    ]
  }
}

{
  "status": "failed",
  "message": "UNAUTHORIZED",
  "error": {
    "type": "UNAUTHORIZED",
    "code": "10401",
    "message": "unauthorized"
  }
}

{
  "status": "failed",
  "message": "<string>",
  "error": {
    "type": "FORBIDDEN",
    "code": "10403",
    "message": "Forbidden"
  }
}

GET

transfers

recipients

List transfer recipients

curl --request GET \
  --url https://developersandbox-api.flutterwave.com/transfers/recipients \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://developersandbox-api.flutterwave.com/transfers/recipients"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://developersandbox-api.flutterwave.com/transfers/recipients', 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://developersandbox-api.flutterwave.com/transfers/recipients",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://developersandbox-api.flutterwave.com/transfers/recipients"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://developersandbox-api.flutterwave.com/transfers/recipients")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "message": "<string>",
  "data": {
    "cursor": {
      "next": "MjAyNC0xMS0yN1QxMjozMjozNC42MjBa",
      "previous": "MjAyNC0xMS0yOVQwMjoxMDo1My45OTla",
      "limit": 10,
      "total": 1000,
      "has_more_items": true
    },
    "recipients": [
      {
        "bank": {
          "account_number": "<string>",
          "code": "<string>",
          "branch": "<string>",
          "name": "<string>",
          "routing_number": "<string>",
          "swift_code": "<string>",
          "sort_code": "<string>"
        },
        "id": "<string>",
        "type": "bank",
        "name": {
          "first": "King",
          "middle": "Leo",
          "last": "LeBron"
        },
        "currency": "NGN",
        "national_identification": {
          "identifier": "FLY5869798686",
          "expiration_date": "2029-07-08"
        },
        "phone": {
          "country_code": "234",
          "number": "08012345678"
        },
        "date_of_birth": "<string>",
        "email": "hi@flutterwave.com",
        "address": {
          "city": "New York",
          "country": "US",
          "line1": "123 Main Street",
          "postal_code": "10001",
          "state": "New York",
          "line2": "Apt 4B"
        }
      }
    ]
  }
}

{
  "status": "failed",
  "error": {
    "type": "REQUEST_NOT_VALID",
    "code": "10400",
    "message": "Request is not valid",
    "validation_errors": [
      {
        "field_name": "amount",
        "message": "must not be null"
      }
    ]
  }
}

{
  "status": "failed",
  "message": "UNAUTHORIZED",
  "error": {
    "type": "UNAUTHORIZED",
    "code": "10401",
    "message": "unauthorized"
  }
}

{
  "status": "failed",
  "message": "<string>",
  "error": {
    "type": "FORBIDDEN",
    "code": "10403",
    "message": "Forbidden"
  }
}

Authorizations

Authorization

string

header

required

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

Headers

X-Trace-Id

string

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

Required string length: 12 - 255

Query Parameters

string

Example:

"MjAyNC0xMS0yN1QxMjozMjozNC42MjBa"

string

Example:

"MjAyNC0xMS0yOVQwMjoxMDo1My45OTla"

size

integer

default:10

Length of data returned. Defaults to 10.

Required range: 10 <= x <= 50

Response

status

enum<string>

Available options:

success,

failed

message

string

data

object

Show child attributes

Customer

Charges

Orchestration

Checkout

Payment Methods

Mobile Networks

Banks

Wallets

Transfers

Transfer Recipients

Transfer Senders

Transfer Rates

Profile

Webhook Endpoints

Internal

Settlement

Chargebacks

Refunds

Fees

Orders

Virtual-Accounts

charge.completed

transfer.disburse

transfer.reversal

order.authorization

refund.completed

List transfer recipients

Authorizations

Headers

Query Parameters

Response