Skip to main content
POST
/
v1
/
external_accounts
Create an external account
curl --request POST \
  --url https://api.leanrails.com/v1/external_accounts \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "account_number": "<string>",
  "country": "<string>",
  "currency": "<string>",
  "routing_number": "<string>",
  "account_holder_name": "<string>",
  "account_holder_type": "individual",
  "default_for_currency": true,
  "metadata": {}
}
'
{
  "id": "ba_xxx",
  "object": "bank_account",
  "available_payout_methods": [
    "<string>"
  ],
  "country": "<string>",
  "currency": "<string>",
  "default_for_currency": true,
  "last4": "<string>",
  "status": "<string>",
  "metadata": {},
  "created": 123,
  "livemode": true,
  "account_holder_name": "<string>",
  "account_holder_type": "individual",
  "account_type": "checking",
  "bank_name": "<string>",
  "fingerprint": "<string>",
  "routing_number": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.fluveo.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Use your secret API key as the username with an empty password.

Headers

​
Idempotency-Key
string
required

Unique key to ensure idempotent requests.

Maximum string length: 255
​
X-API-Version
string

Override the API version for this request.

Body

application/json
​
account_number
string
required

The bank account number.

Minimum string length: 1
​
country
string
required

Two-letter ISO country code.

Required string length: 2
​
currency
string
required

Three-letter ISO currency code.

Required string length: 3
​
routing_number
string

The routing number (required for US accounts).

​
account_holder_name
string

Name of the account holder.

Maximum string length: 256
​
account_holder_type
enum<string>

Type of account holder.

Available options:
individual,
company
​
default_for_currency
boolean

If true, sets this as the default payout account for the currency.

​
metadata
object

Set of key-value pairs for storing additional information.

Response

The created ExternalAccount.

​
id
string
required
Example:

"ba_xxx"

​
object
enum<string>
required
Available options:
bank_account
​
available_payout_methods
string[]
required

Payout methods available for this account.

​
country
string
required

Two-letter ISO country code.

​
currency
string
required

Three-letter ISO currency code.

​
default_for_currency
boolean
required

Whether this is the default payout account for its currency.

​
last4
string
required

Last four digits of the account number.

​
status
string
required

Verification status of the account.

​
metadata
object
required

Set of key-value pairs for storing additional information.

​
created
integer
required

Unix timestamp.

​
livemode
boolean
required
​
account_holder_name
string | null

Name of the account holder.

​
account_holder_type
enum<string> | null
Available options:
individual,
company
​
account_type
enum<string> | null
Available options:
checking,
savings
​
bank_name
string | null
​
fingerprint
string | null

Uniquely identifies this account across all merchants.

​
routing_number
string | null

Bank routing number.