curl --request POST \
--url https://mapi.boomfi.xyz/v1/accounts/external-account \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"currencies": [
"USDC"
],
"name": "Treasury (Base)",
"reference": "treasury-base",
"type": "Digital",
"account_holder_name": "<string>",
"account_number": "<string>",
"address": "<string>",
"bank_name": "<string>",
"business_name": "<string>",
"chain_id": 8453,
"country": "DE",
"first_name": "<string>",
"last_name": "<string>"
}
'import requests
url = "https://mapi.boomfi.xyz/v1/accounts/external-account"
payload = {
"currencies": ["USDC"],
"name": "Treasury (Base)",
"reference": "treasury-base",
"type": "Digital",
"account_holder_name": "<string>",
"account_number": "<string>",
"address": "<string>",
"bank_name": "<string>",
"business_name": "<string>",
"chain_id": 8453,
"country": "DE",
"first_name": "<string>",
"last_name": "<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({
currencies: ['USDC'],
name: 'Treasury (Base)',
reference: 'treasury-base',
type: 'Digital',
account_holder_name: '<string>',
account_number: '<string>',
address: '<string>',
bank_name: '<string>',
business_name: '<string>',
chain_id: 8453,
country: 'DE',
first_name: '<string>',
last_name: '<string>'
})
};
fetch('https://mapi.boomfi.xyz/v1/accounts/external-account', 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://mapi.boomfi.xyz/v1/accounts/external-account",
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([
'currencies' => [
'USDC'
],
'name' => 'Treasury (Base)',
'reference' => 'treasury-base',
'type' => 'Digital',
'account_holder_name' => '<string>',
'account_number' => '<string>',
'address' => '<string>',
'bank_name' => '<string>',
'business_name' => '<string>',
'chain_id' => 8453,
'country' => 'DE',
'first_name' => '<string>',
'last_name' => '<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://mapi.boomfi.xyz/v1/accounts/external-account"
payload := strings.NewReader("{\n \"currencies\": [\n \"USDC\"\n ],\n \"name\": \"Treasury (Base)\",\n \"reference\": \"treasury-base\",\n \"type\": \"Digital\",\n \"account_holder_name\": \"<string>\",\n \"account_number\": \"<string>\",\n \"address\": \"<string>\",\n \"bank_name\": \"<string>\",\n \"business_name\": \"<string>\",\n \"chain_id\": 8453,\n \"country\": \"DE\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<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://mapi.boomfi.xyz/v1/accounts/external-account")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"currencies\": [\n \"USDC\"\n ],\n \"name\": \"Treasury (Base)\",\n \"reference\": \"treasury-base\",\n \"type\": \"Digital\",\n \"account_holder_name\": \"<string>\",\n \"account_number\": \"<string>\",\n \"address\": \"<string>\",\n \"bank_name\": \"<string>\",\n \"business_name\": \"<string>\",\n \"chain_id\": 8453,\n \"country\": \"DE\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://mapi.boomfi.xyz/v1/accounts/external-account")
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 \"currencies\": [\n \"USDC\"\n ],\n \"name\": \"Treasury (Base)\",\n \"reference\": \"treasury-base\",\n \"type\": \"Digital\",\n \"account_holder_name\": \"<string>\",\n \"account_number\": \"<string>\",\n \"address\": \"<string>\",\n \"bank_name\": \"<string>\",\n \"business_name\": \"<string>\",\n \"chain_id\": 8453,\n \"country\": \"DE\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"account_holder_name_hint": "<string>",
"account_number_hint": "<string>",
"address": "<string>",
"bank_name": "<string>",
"beneficiary_type": "individual",
"chain_id": 123,
"country": "<string>",
"created_at": "<string>",
"currencies": [
"<string>"
],
"enabled": true,
"id": 123,
"name": "<string>",
"payment_rail": "SEPA",
"reference": "<string>",
"type": "Digital"
},
"error": true,
"message": "<string>"
}{
"error": {
"code": 400,
"errors": [
{
"domain": "orders",
"reason": "InsufficientQuantity"
}
],
"message": "Insufficient quantity"
}
}{
"error": {
"code": 400,
"errors": [
{
"domain": "orders",
"reason": "InsufficientQuantity"
}
],
"message": "Insufficient quantity"
}
}{
"error": {
"code": 400,
"errors": [
{
"domain": "orders",
"reason": "InsufficientQuantity"
}
],
"message": "Insufficient quantity"
}
}{
"error": {
"code": 400,
"errors": [
{
"domain": "orders",
"reason": "InsufficientQuantity"
}
],
"message": "Insufficient quantity"
}
}Register External Account
Register a payout destination the merchant controls: a wallet address (type Digital) or a bank account (type Fiat). Registering is the whitelisting step — /accounts/virtual/payout only sends to accounts created here — so this endpoint requires X-Step-Up-Token when authenticated with a Bearer session.
curl --request POST \
--url https://mapi.boomfi.xyz/v1/accounts/external-account \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"currencies": [
"USDC"
],
"name": "Treasury (Base)",
"reference": "treasury-base",
"type": "Digital",
"account_holder_name": "<string>",
"account_number": "<string>",
"address": "<string>",
"bank_name": "<string>",
"business_name": "<string>",
"chain_id": 8453,
"country": "DE",
"first_name": "<string>",
"last_name": "<string>"
}
'import requests
url = "https://mapi.boomfi.xyz/v1/accounts/external-account"
payload = {
"currencies": ["USDC"],
"name": "Treasury (Base)",
"reference": "treasury-base",
"type": "Digital",
"account_holder_name": "<string>",
"account_number": "<string>",
"address": "<string>",
"bank_name": "<string>",
"business_name": "<string>",
"chain_id": 8453,
"country": "DE",
"first_name": "<string>",
"last_name": "<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({
currencies: ['USDC'],
name: 'Treasury (Base)',
reference: 'treasury-base',
type: 'Digital',
account_holder_name: '<string>',
account_number: '<string>',
address: '<string>',
bank_name: '<string>',
business_name: '<string>',
chain_id: 8453,
country: 'DE',
first_name: '<string>',
last_name: '<string>'
})
};
fetch('https://mapi.boomfi.xyz/v1/accounts/external-account', 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://mapi.boomfi.xyz/v1/accounts/external-account",
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([
'currencies' => [
'USDC'
],
'name' => 'Treasury (Base)',
'reference' => 'treasury-base',
'type' => 'Digital',
'account_holder_name' => '<string>',
'account_number' => '<string>',
'address' => '<string>',
'bank_name' => '<string>',
'business_name' => '<string>',
'chain_id' => 8453,
'country' => 'DE',
'first_name' => '<string>',
'last_name' => '<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://mapi.boomfi.xyz/v1/accounts/external-account"
payload := strings.NewReader("{\n \"currencies\": [\n \"USDC\"\n ],\n \"name\": \"Treasury (Base)\",\n \"reference\": \"treasury-base\",\n \"type\": \"Digital\",\n \"account_holder_name\": \"<string>\",\n \"account_number\": \"<string>\",\n \"address\": \"<string>\",\n \"bank_name\": \"<string>\",\n \"business_name\": \"<string>\",\n \"chain_id\": 8453,\n \"country\": \"DE\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<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://mapi.boomfi.xyz/v1/accounts/external-account")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"currencies\": [\n \"USDC\"\n ],\n \"name\": \"Treasury (Base)\",\n \"reference\": \"treasury-base\",\n \"type\": \"Digital\",\n \"account_holder_name\": \"<string>\",\n \"account_number\": \"<string>\",\n \"address\": \"<string>\",\n \"bank_name\": \"<string>\",\n \"business_name\": \"<string>\",\n \"chain_id\": 8453,\n \"country\": \"DE\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://mapi.boomfi.xyz/v1/accounts/external-account")
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 \"currencies\": [\n \"USDC\"\n ],\n \"name\": \"Treasury (Base)\",\n \"reference\": \"treasury-base\",\n \"type\": \"Digital\",\n \"account_holder_name\": \"<string>\",\n \"account_number\": \"<string>\",\n \"address\": \"<string>\",\n \"bank_name\": \"<string>\",\n \"business_name\": \"<string>\",\n \"chain_id\": 8453,\n \"country\": \"DE\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"account_holder_name_hint": "<string>",
"account_number_hint": "<string>",
"address": "<string>",
"bank_name": "<string>",
"beneficiary_type": "individual",
"chain_id": 123,
"country": "<string>",
"created_at": "<string>",
"currencies": [
"<string>"
],
"enabled": true,
"id": 123,
"name": "<string>",
"payment_rail": "SEPA",
"reference": "<string>",
"type": "Digital"
},
"error": true,
"message": "<string>"
}{
"error": {
"code": 400,
"errors": [
{
"domain": "orders",
"reason": "InsufficientQuantity"
}
],
"message": "Insufficient quantity"
}
}{
"error": {
"code": 400,
"errors": [
{
"domain": "orders",
"reason": "InsufficientQuantity"
}
],
"message": "Insufficient quantity"
}
}{
"error": {
"code": 400,
"errors": [
{
"domain": "orders",
"reason": "InsufficientQuantity"
}
],
"message": "Insufficient quantity"
}
}{
"error": {
"code": 400,
"errors": [
{
"domain": "orders",
"reason": "InsufficientQuantity"
}
],
"message": "Insufficient quantity"
}
}Authorizations
Headers
Step-up token required for Bearer/session auth (ignored for API-key auth)
Target sub-merchant organisation ID. Required for partner-delegated requests, which must be signed with the partner secret.
Body
body
Currencies this account can receive. A Fiat account takes exactly one.
1["USDC"]
Display name.
255"Treasury (Base)"
Merchant's own reference. Payouts can name this account by it.
255"treasury-base"
Kind of destination, mirroring our currency_type enum: Digital (a wallet) or Fiat (a bank account).
Digital, Fiat "Digital"
Name on the bank account. Fiat only, required.
Bank account number or IBAN. Fiat only, required. Encrypted at rest; only a hint is ever returned.
Destination wallet address. Digital only, required.
Name of the beneficiary bank. Fiat only.
Who owns the bank account. Fiat only; defaults to business.
individual, business Beneficiary business name. Fiat only; defaults to account_holder_name for a business.
Chain id. Digital only, required.
8453
ISO 3166-1 alpha-2 country of the bank account. Fiat only, required.
"DE"
Beneficiary first name. Fiat only, required when beneficiary_type is individual.
Beneficiary last name. Fiat only, required when beneficiary_type is individual.
Payment rail to settle on. Fiat only; defaults to SEPA.
SEPA, SEPA_INSTANT