Update a transfer

This can only be used to update instructions about a deferred payout.

PUT /transfers/{id}

Update a transfer

cURL

curl --request PUT \
  --url https://developersandbox-api.flutterwave.com/transfers/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "initiate": "true",
  "close": "false",
  "disburse_option": {
    "date_time": "<string>"
  }
}
'

import requests

url = "https://developersandbox-api.flutterwave.com/transfers/{id}"

payload = {
    "initiate": "true",
    "close": "false",
    "disburse_option": { "date_time": "<string>" }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({initiate: 'true', close: 'false', disburse_option: {date_time: '<string>'}})
};

fetch('https://developersandbox-api.flutterwave.com/transfers/{id}', 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/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'initiate' => 'true',
    'close' => 'false',
    'disburse_option' => [
        'date_time' => '<string>'
    ]
  ]),
  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://developersandbox-api.flutterwave.com/transfers/{id}"

	payload := strings.NewReader("{\n  \"initiate\": \"true\",\n  \"close\": \"false\",\n  \"disburse_option\": {\n    \"date_time\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://developersandbox-api.flutterwave.com/transfers/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"initiate\": \"true\",\n  \"close\": \"false\",\n  \"disburse_option\": {\n    \"date_time\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"initiate\": \"true\",\n  \"close\": \"false\",\n  \"disburse_option\": {\n    \"date_time\": \"<string>\"\n  }\n}"

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

200

{
  "message": "<string>",
  "data": {
    "id": "trf_yuK89vb",
    "action": "instant",
    "status": "CANCELLED",
    "disburse_option": {
      "date_time": "<string>"
    },
    "updated_datetime": "2023-11-07T05:31:56Z"
  }
}

{
  "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

Path Parameters

id · string · required

ID of the transfer

Body

application/json

initiate · boolean

Used to initiate a deferred or scheduled transfer

Example:

"true"

close · boolean

Used to close a deferred or scheduled transfer.

Example:

"false"

disburse_option · object

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

Show child attributes

Response

200

application/json

OK

status · enum<string>

Available options: success, failed

message · string

data · object

Show child attributes