POST
/
fees
/
preview
Preview fees for a planned transaction
curl --request POST \
  --url https://api.balansas.com/functions/v1/customer-api/fees/preview \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "amount": 123,
  "currency": "<string>",
  "transactionType": "<string>",
  "paymentScheme": "<string>"
}
'
import requests

url = "https://api.balansas.com/functions/v1/customer-api/fees/preview"

payload = {
"amount": 123,
"currency": "<string>",
"transactionType": "<string>",
"paymentScheme": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amount: 123,
currency: '<string>',
transactionType: '<string>',
paymentScheme: '<string>'
})
};

fetch('https://api.balansas.com/functions/v1/customer-api/fees/preview', 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.balansas.com/functions/v1/customer-api/fees/preview",
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([
'amount' => 123,
'currency' => '<string>',
'transactionType' => '<string>',
'paymentScheme' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <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.balansas.com/functions/v1/customer-api/fees/preview"

payload := strings.NewReader("{\n \"amount\": 123,\n \"currency\": \"<string>\",\n \"transactionType\": \"<string>\",\n \"paymentScheme\": \"<string>\"\n}")

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

req.Header.Add("x-api-key", "<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.post("https://api.balansas.com/functions/v1/customer-api/fees/preview")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 123,\n \"currency\": \"<string>\",\n \"transactionType\": \"<string>\",\n \"paymentScheme\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.balansas.com/functions/v1/customer-api/fees/preview")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 123,\n \"currency\": \"<string>\",\n \"transactionType\": \"<string>\",\n \"paymentScheme\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "fee_amount": 2.5,
    "fee_currency": "EUR",
    "schedule_id": "9c8b7a6d-5e4f-4321-8a9b-0c1d2e3f4a5b",
    "schedule_name": "EU SEPA Standard",
    "umbrella_link_id": null,
    "goat_member_code": null,
    "breakdown": {
      "flat_fee": 0.5,
      "percentage_fee": 0.25,
      "percentage_amount": 2,
      "raw_total": 2.5,
      "min_applied": false,
      "max_applied": false
    }
  }
}
{
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}
}
{
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}
}
{
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}
}
{
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}
}
{
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}
}
{
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}
}

Authorizations

x-api-key
string
header
required

Customer API key. Send as x-api-key: sk_... or Authorization: Bearer sk_.... Write operations also require an X-CSRF-Token header (64-char hex).

Body

application/json
amount
number
required
currency
string
required
Required string length: 1 - 10
transactionType
string
required
Required string length: 1 - 50
paymentScheme
string
Maximum string length: 50

Response

Success

data
object
required