Add a bank account

curl --request POST \
  --url https://api.agentaos.ai/api/v1/gateway/bank-accounts \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "currency": "EUR",
  "type": "iban",
  "accountHolderName": "Seller GmbH",
  "legalType": "BUSINESS",
  "details": {
    "IBAN": "DE89370400440532013000"
  }
}
'

import requests

url = "https://api.agentaos.ai/api/v1/gateway/bank-accounts"

payload = {
    "currency": "EUR",
    "type": "iban",
    "accountHolderName": "Seller GmbH",
    "legalType": "BUSINESS",
    "details": { "IBAN": "DE89370400440532013000" }
}
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({
    currency: 'EUR',
    type: 'iban',
    accountHolderName: 'Seller GmbH',
    legalType: 'BUSINESS',
    details: {IBAN: 'DE89370400440532013000'}
  })
};

fetch('https://api.agentaos.ai/api/v1/gateway/bank-accounts', 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.agentaos.ai/api/v1/gateway/bank-accounts",
  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([
    'currency' => 'EUR',
    'type' => 'iban',
    'accountHolderName' => 'Seller GmbH',
    'legalType' => 'BUSINESS',
    'details' => [
        'IBAN' => 'DE89370400440532013000'
    ]
  ]),
  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.agentaos.ai/api/v1/gateway/bank-accounts"

	payload := strings.NewReader("{\n  \"currency\": \"EUR\",\n  \"type\": \"iban\",\n  \"accountHolderName\": \"Seller GmbH\",\n  \"legalType\": \"BUSINESS\",\n  \"details\": {\n    \"IBAN\": \"DE89370400440532013000\"\n  }\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.agentaos.ai/api/v1/gateway/bank-accounts")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"currency\": \"EUR\",\n  \"type\": \"iban\",\n  \"accountHolderName\": \"Seller GmbH\",\n  \"legalType\": \"BUSINESS\",\n  \"details\": {\n    \"IBAN\": \"DE89370400440532013000\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.agentaos.ai/api/v1/gateway/bank-accounts")

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  \"currency\": \"EUR\",\n  \"type\": \"iban\",\n  \"accountHolderName\": \"Seller GmbH\",\n  \"legalType\": \"BUSINESS\",\n  \"details\": {\n    \"IBAN\": \"DE89370400440532013000\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "currency": "<string>",
  "account_type": "<string>",
  "account_identifier_last4": "<string>",
  "account_holder_name": "<string>",
  "legal_type": "PRIVATE",
  "name_match_status": "success",
  "active": true,
  "payable": true,
  "payableReason": "<string>"
}

{
  "statusCode": 400,
  "code": "RECIPIENT_INVALID",
  "fieldErrors": [
    {
      "path": "details.IBAN",
      "message": "Not a valid IBAN."
    }
  ],
  "message": "<string>"
}

{
  "statusCode": 401,
  "message": "Invalid API key",
  "timestamp": "2026-08-06T12:00:00.000Z"
}

{
  "statusCode": 403,
  "message": "Bank accounts by API are not enabled for your platform. Ask us to open it, or add the account from the dashboard.",
  "code": "bank_accounts_by_api_closed"
}

Bank Accounts

Add a bank account

Save a bank account for the business. Where the bank offers a name check, it runs at once: a clear mismatch is saved but never paid, and payableReason says so. Needs a live key. For a platform acting on a business it manages, bank accounts by API must have been opened for your platform; ask us. Every account added through a platform’s key is emailed to the platform’s owner and to the business’s owner. The account number is never stored: we keep the last four characters and a hash.

POST

gateway

bank-accounts

Add a bank account

curl --request POST \
  --url https://api.agentaos.ai/api/v1/gateway/bank-accounts \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "currency": "EUR",
  "type": "iban",
  "accountHolderName": "Seller GmbH",
  "legalType": "BUSINESS",
  "details": {
    "IBAN": "DE89370400440532013000"
  }
}
'

import requests

url = "https://api.agentaos.ai/api/v1/gateway/bank-accounts"

payload = {
    "currency": "EUR",
    "type": "iban",
    "accountHolderName": "Seller GmbH",
    "legalType": "BUSINESS",
    "details": { "IBAN": "DE89370400440532013000" }
}
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({
    currency: 'EUR',
    type: 'iban',
    accountHolderName: 'Seller GmbH',
    legalType: 'BUSINESS',
    details: {IBAN: 'DE89370400440532013000'}
  })
};

fetch('https://api.agentaos.ai/api/v1/gateway/bank-accounts', 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.agentaos.ai/api/v1/gateway/bank-accounts",
  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([
    'currency' => 'EUR',
    'type' => 'iban',
    'accountHolderName' => 'Seller GmbH',
    'legalType' => 'BUSINESS',
    'details' => [
        'IBAN' => 'DE89370400440532013000'
    ]
  ]),
  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.agentaos.ai/api/v1/gateway/bank-accounts"

	payload := strings.NewReader("{\n  \"currency\": \"EUR\",\n  \"type\": \"iban\",\n  \"accountHolderName\": \"Seller GmbH\",\n  \"legalType\": \"BUSINESS\",\n  \"details\": {\n    \"IBAN\": \"DE89370400440532013000\"\n  }\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.agentaos.ai/api/v1/gateway/bank-accounts")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"currency\": \"EUR\",\n  \"type\": \"iban\",\n  \"accountHolderName\": \"Seller GmbH\",\n  \"legalType\": \"BUSINESS\",\n  \"details\": {\n    \"IBAN\": \"DE89370400440532013000\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.agentaos.ai/api/v1/gateway/bank-accounts")

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  \"currency\": \"EUR\",\n  \"type\": \"iban\",\n  \"accountHolderName\": \"Seller GmbH\",\n  \"legalType\": \"BUSINESS\",\n  \"details\": {\n    \"IBAN\": \"DE89370400440532013000\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "currency": "<string>",
  "account_type": "<string>",
  "account_identifier_last4": "<string>",
  "account_holder_name": "<string>",
  "legal_type": "PRIVATE",
  "name_match_status": "success",
  "active": true,
  "payable": true,
  "payableReason": "<string>"
}

{
  "statusCode": 400,
  "code": "RECIPIENT_INVALID",
  "fieldErrors": [
    {
      "path": "details.IBAN",
      "message": "Not a valid IBAN."
    }
  ],
  "message": "<string>"
}

{
  "statusCode": 401,
  "message": "Invalid API key",
  "timestamp": "2026-08-06T12:00:00.000Z"
}

{
  "statusCode": 403,
  "message": "Bank accounts by API are not enabled for your platform. Ask us to open it, or add the account from the dashboard.",
  "code": "bank_accounts_by_api_closed"
}

Needs a live key. For a platform acting on a business it manages, ask us to open bank accounts by API for your platform first; until then the call gets 403 bank_accounts_by_api_closed. Where the bank offers a name check, it runs at once: a clear mismatch is saved but never paid, and payableReason says so; partial and unknown are paid. Every account added through a platform’s key is emailed to the platform’s owner and to the business’s owner. We keep the last four digits and a hash, never the number.

Bank accounts by API

The flow end to end, with the SDK.

Build a platform

Managing businesses, start to finish.

Authorizations

x-api-key

string

header

required

Your secret key, from app.agentaos.ai -> Settings -> Developers -> API Keys. The key's prefix is both its identity and its environment: sk_test_... (sandbox, free, no verification) or sk_live_... (real money, requires business verification). A missing or invalid key returns 401.

Body

application/json

currency

string

required

The payout currency. EUR and USD are supported.

type

string

required

The account type from the requirements: iban, sort_code, aba.

accountHolderName

string

required

The name on the bank account, as the bank holds it. A clear mismatch is saved but not paid.

legalType

enum<string>

required

Available options:

PRIVATE,

BUSINESS

details

object

required

The fields the requirements asked for, for example { "IBAN": "DE89…" }. Never stored: we keep the last four characters and a hash.

Response

The saved account, as a thin reference.

A bank account as we keep it: a thin reference. The account number itself stays with our bank partner.

string<uuid>

required

currency

string

required

Upper-case, EUR or USD.

account_type

string

required

The corridor: iban, sort_code, aba.

account_identifier_last4

string

required

The last four characters of the account number.

account_holder_name

string

required

legal_type

enum<string>

required

Available options:

PRIVATE,

BUSINESS

name_match_status

enum<string>

required

How the holder name compared with the name the bank holds, where the bank offers that check (not for every currency). failed is never paid; partial and unknown are paid.

Available options:

success,

partial,

failed,

unknown

active

boolean

required

payable

boolean

required

Can the next payout go to this account right now: active, and the name check did not fail.

payableReason

string | null

required

When payable is false: why, in a sentence for the merchant.

SDK

CLI

API Reference

Add a bank account

Bank accounts by API

Build a platform

Authorizations

Body

Response