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

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