POST
/
payees
Create a payee
curl --request POST \
  --url https://api.balansas.com/functions/v1/customer-api/payees \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "address": {
    "line1": "<string>",
    "city": "<string>",
    "postalCode": "<string>",
    "country": "<string>",
    "line2": "<string>",
    "stateRegion": "<string>"
  },
  "bankDetails": {
    "iban": "<string>",
    "bic": "<string>",
    "sortCode": "<string>",
    "accountNumber": "<string>",
    "routingNumber": "<string>",
    "accountHolderName": "<string>",
    "bankName": "<string>",
    "bankAddressLine1": "<string>",
    "bankAddressCity": "<string>",
    "bankAddressPostalCode": "<string>",
    "bankAddressCountry": "<string>",
    "intermediaryBicSwift": "<string>",
    "intermediaryBankName": "<string>",
    "intermediaryBankAddressLine1": "<string>",
    "intermediaryBankAddressCity": "<string>",
    "intermediaryBankAddressPostalCode": "<string>",
    "intermediaryBankAddressCountry": "<string>"
  },
  "endUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "umbrellaLinkId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
import requests

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

payload = {
"name": "<string>",
"address": {
"line1": "<string>",
"city": "<string>",
"postalCode": "<string>",
"country": "<string>",
"line2": "<string>",
"stateRegion": "<string>"
},
"bankDetails": {
"iban": "<string>",
"bic": "<string>",
"sortCode": "<string>",
"accountNumber": "<string>",
"routingNumber": "<string>",
"accountHolderName": "<string>",
"bankName": "<string>",
"bankAddressLine1": "<string>",
"bankAddressCity": "<string>",
"bankAddressPostalCode": "<string>",
"bankAddressCountry": "<string>",
"intermediaryBicSwift": "<string>",
"intermediaryBankName": "<string>",
"intermediaryBankAddressLine1": "<string>",
"intermediaryBankAddressCity": "<string>",
"intermediaryBankAddressPostalCode": "<string>",
"intermediaryBankAddressCountry": "<string>"
},
"endUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"umbrellaLinkId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
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({
name: '<string>',
address: {
line1: '<string>',
city: '<string>',
postalCode: '<string>',
country: '<string>',
line2: '<string>',
stateRegion: '<string>'
},
bankDetails: {
iban: '<string>',
bic: '<string>',
sortCode: '<string>',
accountNumber: '<string>',
routingNumber: '<string>',
accountHolderName: '<string>',
bankName: '<string>',
bankAddressLine1: '<string>',
bankAddressCity: '<string>',
bankAddressPostalCode: '<string>',
bankAddressCountry: '<string>',
intermediaryBicSwift: '<string>',
intermediaryBankName: '<string>',
intermediaryBankAddressLine1: '<string>',
intermediaryBankAddressCity: '<string>',
intermediaryBankAddressPostalCode: '<string>',
intermediaryBankAddressCountry: '<string>'
},
endUserId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
umbrellaLinkId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};

fetch('https://api.balansas.com/functions/v1/customer-api/payees', 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/payees",
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([
'name' => '<string>',
'address' => [
'line1' => '<string>',
'city' => '<string>',
'postalCode' => '<string>',
'country' => '<string>',
'line2' => '<string>',
'stateRegion' => '<string>'
],
'bankDetails' => [
'iban' => '<string>',
'bic' => '<string>',
'sortCode' => '<string>',
'accountNumber' => '<string>',
'routingNumber' => '<string>',
'accountHolderName' => '<string>',
'bankName' => '<string>',
'bankAddressLine1' => '<string>',
'bankAddressCity' => '<string>',
'bankAddressPostalCode' => '<string>',
'bankAddressCountry' => '<string>',
'intermediaryBicSwift' => '<string>',
'intermediaryBankName' => '<string>',
'intermediaryBankAddressLine1' => '<string>',
'intermediaryBankAddressCity' => '<string>',
'intermediaryBankAddressPostalCode' => '<string>',
'intermediaryBankAddressCountry' => '<string>'
],
'endUserId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'umbrellaLinkId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
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/payees"

payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"address\": {\n \"line1\": \"<string>\",\n \"city\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"line2\": \"<string>\",\n \"stateRegion\": \"<string>\"\n },\n \"bankDetails\": {\n \"iban\": \"<string>\",\n \"bic\": \"<string>\",\n \"sortCode\": \"<string>\",\n \"accountNumber\": \"<string>\",\n \"routingNumber\": \"<string>\",\n \"accountHolderName\": \"<string>\",\n \"bankName\": \"<string>\",\n \"bankAddressLine1\": \"<string>\",\n \"bankAddressCity\": \"<string>\",\n \"bankAddressPostalCode\": \"<string>\",\n \"bankAddressCountry\": \"<string>\",\n \"intermediaryBicSwift\": \"<string>\",\n \"intermediaryBankName\": \"<string>\",\n \"intermediaryBankAddressLine1\": \"<string>\",\n \"intermediaryBankAddressCity\": \"<string>\",\n \"intermediaryBankAddressPostalCode\": \"<string>\",\n \"intermediaryBankAddressCountry\": \"<string>\"\n },\n \"endUserId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"umbrellaLinkId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\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/payees")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"address\": {\n \"line1\": \"<string>\",\n \"city\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"line2\": \"<string>\",\n \"stateRegion\": \"<string>\"\n },\n \"bankDetails\": {\n \"iban\": \"<string>\",\n \"bic\": \"<string>\",\n \"sortCode\": \"<string>\",\n \"accountNumber\": \"<string>\",\n \"routingNumber\": \"<string>\",\n \"accountHolderName\": \"<string>\",\n \"bankName\": \"<string>\",\n \"bankAddressLine1\": \"<string>\",\n \"bankAddressCity\": \"<string>\",\n \"bankAddressPostalCode\": \"<string>\",\n \"bankAddressCountry\": \"<string>\",\n \"intermediaryBicSwift\": \"<string>\",\n \"intermediaryBankName\": \"<string>\",\n \"intermediaryBankAddressLine1\": \"<string>\",\n \"intermediaryBankAddressCity\": \"<string>\",\n \"intermediaryBankAddressPostalCode\": \"<string>\",\n \"intermediaryBankAddressCountry\": \"<string>\"\n },\n \"endUserId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"umbrellaLinkId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();
require 'uri'
require 'net/http'

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

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 \"name\": \"<string>\",\n \"address\": {\n \"line1\": \"<string>\",\n \"city\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"line2\": \"<string>\",\n \"stateRegion\": \"<string>\"\n },\n \"bankDetails\": {\n \"iban\": \"<string>\",\n \"bic\": \"<string>\",\n \"sortCode\": \"<string>\",\n \"accountNumber\": \"<string>\",\n \"routingNumber\": \"<string>\",\n \"accountHolderName\": \"<string>\",\n \"bankName\": \"<string>\",\n \"bankAddressLine1\": \"<string>\",\n \"bankAddressCity\": \"<string>\",\n \"bankAddressPostalCode\": \"<string>\",\n \"bankAddressCountry\": \"<string>\",\n \"intermediaryBicSwift\": \"<string>\",\n \"intermediaryBankName\": \"<string>\",\n \"intermediaryBankAddressLine1\": \"<string>\",\n \"intermediaryBankAddressCity\": \"<string>\",\n \"intermediaryBankAddressPostalCode\": \"<string>\",\n \"intermediaryBankAddressCountry\": \"<string>\"\n },\n \"endUserId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"umbrellaLinkId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "id": "7c4e9a10-2b3d-4f56-8a90-1c2d3e4f5a6b",
    "fr_payee_id": "pay_8Hd2Km",
    "payee_name": "Jane Supplier Ltd",
    "currency": "GBP",
    "status": "active",
    "account_number": "GB29NWBK60161331926819",
    "sort_code": "04-00-04",
    "swift": "NWBKGB2L",
    "bank_name": "NatWest",
    "address_line1": "10 Downing St",
    "address_line2": "Floor 2",
    "city": "London",
    "state_region": "Greater London",
    "postal_code": "SW1A 2AA",
    "country_code": "GB",
    "end_user_id": "3f8a1c2d-4b5e-4f60-9a71-2b3c4d5e6f70",
    "requires_vop": false,
    "fr_owner_business_id": "busi_8Jh2KdLm5Qx",
    "created_at": "2026-05-28T11:02:09.456Z"
  }
}
{
"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
name
string
required
Required string length: 1 - 200
type
enum<string>
required
Available options:
PERSON,
BUSINESS
currency
enum<string>
required
Available options:
USD,
EUR,
GBP
address
object
required
bankDetails
object
required
endUserId
string<uuid>

Response

Success

data
object
required