curl --request POST \
--url https://20b9-41-90-209-232.ngrok-free.app/v1/payouts/fee \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"beneficiary_id": "bbd938a2-dbbe-43bf-bfb9-1c5dbe444523",
"currency": "NGN",
"amount": 5000000
}
'const url = 'https://20b9-41-90-209-232.ngrok-free.app/v1/payouts/fee';
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
beneficiary_id: 'bbd938a2-dbbe-43bf-bfb9-1c5dbe444523',
currency: 'NGN',
amount: 5000000
})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));import requests
url = "https://20b9-41-90-209-232.ngrok-free.app/v1/payouts/fee"
payload = {
"beneficiary_id": "bbd938a2-dbbe-43bf-bfb9-1c5dbe444523",
"currency": "NGN",
"amount": 5000000
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://20b9-41-90-209-232.ngrok-free.app/v1/payouts/fee"
payload := strings.NewReader("{\n \"beneficiary_id\": \"bbd938a2-dbbe-43bf-bfb9-1c5dbe444523\",\n \"currency\": \"NGN\",\n \"amount\": 5000000\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))
}{
"object": "payout_fee",
"currency": "NGN",
"amount": 5000000,
"transfer_fee": 10000,
"total": 5000000,
"exact": false,
"scale": 2
}{
"error": {
"type": "authentication_error",
"code": "invalid_api_key",
"message": "Invalid API key provided."
}
}Payout Fee
Estimate transfer fee before creating a payout.
curl --request POST \
--url https://20b9-41-90-209-232.ngrok-free.app/v1/payouts/fee \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"beneficiary_id": "bbd938a2-dbbe-43bf-bfb9-1c5dbe444523",
"currency": "NGN",
"amount": 5000000
}
'const url = 'https://20b9-41-90-209-232.ngrok-free.app/v1/payouts/fee';
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
beneficiary_id: 'bbd938a2-dbbe-43bf-bfb9-1c5dbe444523',
currency: 'NGN',
amount: 5000000
})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));import requests
url = "https://20b9-41-90-209-232.ngrok-free.app/v1/payouts/fee"
payload = {
"beneficiary_id": "bbd938a2-dbbe-43bf-bfb9-1c5dbe444523",
"currency": "NGN",
"amount": 5000000
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://20b9-41-90-209-232.ngrok-free.app/v1/payouts/fee"
payload := strings.NewReader("{\n \"beneficiary_id\": \"bbd938a2-dbbe-43bf-bfb9-1c5dbe444523\",\n \"currency\": \"NGN\",\n \"amount\": 5000000\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))
}{
"object": "payout_fee",
"currency": "NGN",
"amount": 5000000,
"transfer_fee": 10000,
"total": 5000000,
"exact": false,
"scale": 2
}{
"error": {
"type": "authentication_error",
"code": "invalid_api_key",
"message": "Invalid API key provided."
}
}Authorizations
Secret API key from Settings → Developers → API keys.
Example: Authorization: Bearer sk_test_…
Body
Beneficiary the fee estimate applies to.
"bbd938a2-dbbe-43bf-bfb9-1c5dbe444523"
Source book currency for the planned send.
"NGN"
Planned send amount in Ledger minor units.
5000000
Optional firm quote id for cross-currency fee accuracy.
Optional estimated recipient amount in their currency minor units when
you do not yet have a firm quote_id.
Response
Fee quote
Object type discriminator.
payout_fee Currency of amount, transfer_fee, and total.
Requested send amount in Ledger minor units.
Estimated customer-visible transfer fee in minor units.
Amount plus fee (what leaves the book), in minor units.
true when the fee is final for this input; false when indicative
(e.g. before a firm FX quote).
Minimum allowed send for this corridor, if applicable.
Decimal places for the currency (usually 2).