Set Withdrawal Fee Bearer
curl --request PUT \
--url https://api.breet.io/v1/users/withdrawal-fee-bearer \
--header 'Content-Type: application/json' \
--header 'X-Breet-Env: <api-key>' \
--header 'x-app-id: <api-key>' \
--header 'x-app-secret: <api-key>' \
--data '
{
"withdrawalFeeBearer": "business"
}
'import requests
url = "https://api.breet.io/v1/users/withdrawal-fee-bearer"
payload = { "withdrawalFeeBearer": "business" }
headers = {
"x-app-id": "<api-key>",
"x-app-secret": "<api-key>",
"X-Breet-Env": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
'x-app-id': '<api-key>',
'x-app-secret': '<api-key>',
'X-Breet-Env': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({withdrawalFeeBearer: 'business'})
};
fetch('https://api.breet.io/v1/users/withdrawal-fee-bearer', 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.breet.io/v1/users/withdrawal-fee-bearer",
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([
'withdrawalFeeBearer' => 'business'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Breet-Env: <api-key>",
"x-app-id: <api-key>",
"x-app-secret: <api-key>"
],
]);
$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.breet.io/v1/users/withdrawal-fee-bearer"
payload := strings.NewReader("{\n \"withdrawalFeeBearer\": \"business\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-app-id", "<api-key>")
req.Header.Add("x-app-secret", "<api-key>")
req.Header.Add("X-Breet-Env", "<api-key>")
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://api.breet.io/v1/users/withdrawal-fee-bearer")
.header("x-app-id", "<api-key>")
.header("x-app-secret", "<api-key>")
.header("X-Breet-Env", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"withdrawalFeeBearer\": \"business\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.breet.io/v1/users/withdrawal-fee-bearer")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-app-id"] = '<api-key>'
request["x-app-secret"] = '<api-key>'
request["X-Breet-Env"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"withdrawalFeeBearer\": \"business\"\n}"
response = http.request(request)
puts response.read_body{
"message": "withdrawal fee bearer set successfully",
"success": true,
"data": {
"withdrawalFeeBearer": "business"
},
"meta": {},
"summary": {},
"stats": {}
}{
"success": false,
"message": "you do not have API access",
"meta": {},
"errors": [],
"data": {}
}{
"success": false,
"message": "validation errors",
"meta": {},
"errors": [
{
"message": "Invalid value",
"field": "amount",
"location": "body"
}
],
"data": {}
}{
"success": false,
"message": "something went wrong!",
"meta": {},
"errors": [],
"data": {}
}Account
Set Withdrawal Fee Bearer
Choose who absorbs the flat fee on bank (NGN | GHS) withdrawals, including auto-settlement payouts. With user, the fee is deducted from the payout and the destination account is credited amount - fee. With business, the fee is added to the amount debited from your balance and the destination account is credited the full amount. Defaults to user. Stablecoin withdrawals are unaffected.
PUT
/
users
/
withdrawal-fee-bearer
Set Withdrawal Fee Bearer
curl --request PUT \
--url https://api.breet.io/v1/users/withdrawal-fee-bearer \
--header 'Content-Type: application/json' \
--header 'X-Breet-Env: <api-key>' \
--header 'x-app-id: <api-key>' \
--header 'x-app-secret: <api-key>' \
--data '
{
"withdrawalFeeBearer": "business"
}
'import requests
url = "https://api.breet.io/v1/users/withdrawal-fee-bearer"
payload = { "withdrawalFeeBearer": "business" }
headers = {
"x-app-id": "<api-key>",
"x-app-secret": "<api-key>",
"X-Breet-Env": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
'x-app-id': '<api-key>',
'x-app-secret': '<api-key>',
'X-Breet-Env': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({withdrawalFeeBearer: 'business'})
};
fetch('https://api.breet.io/v1/users/withdrawal-fee-bearer', 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.breet.io/v1/users/withdrawal-fee-bearer",
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([
'withdrawalFeeBearer' => 'business'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Breet-Env: <api-key>",
"x-app-id: <api-key>",
"x-app-secret: <api-key>"
],
]);
$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.breet.io/v1/users/withdrawal-fee-bearer"
payload := strings.NewReader("{\n \"withdrawalFeeBearer\": \"business\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-app-id", "<api-key>")
req.Header.Add("x-app-secret", "<api-key>")
req.Header.Add("X-Breet-Env", "<api-key>")
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://api.breet.io/v1/users/withdrawal-fee-bearer")
.header("x-app-id", "<api-key>")
.header("x-app-secret", "<api-key>")
.header("X-Breet-Env", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"withdrawalFeeBearer\": \"business\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.breet.io/v1/users/withdrawal-fee-bearer")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-app-id"] = '<api-key>'
request["x-app-secret"] = '<api-key>'
request["X-Breet-Env"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"withdrawalFeeBearer\": \"business\"\n}"
response = http.request(request)
puts response.read_body{
"message": "withdrawal fee bearer set successfully",
"success": true,
"data": {
"withdrawalFeeBearer": "business"
},
"meta": {},
"summary": {},
"stats": {}
}{
"success": false,
"message": "you do not have API access",
"meta": {},
"errors": [],
"data": {}
}{
"success": false,
"message": "validation errors",
"meta": {},
"errors": [
{
"message": "Invalid value",
"field": "amount",
"location": "body"
}
],
"data": {}
}{
"success": false,
"message": "something went wrong!",
"meta": {},
"errors": [],
"data": {}
}Authorizations
Your application ID from the Breet dashboard
Your application secret from the Breet dashboard
Environment selector: development or production
Body
application/json
Who absorbs the withdrawal fee. user deducts it from the payout; business adds it to the amount debited from your balance.
Available options:
user, business Response
Withdrawal fee bearer set successfully
Was this page helpful?