POST
/
externalAccounts
curl --request POST \
  --url https://api.sulu.sh/v0/externalAccounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "organizationId": "<string>",
  "countryCode": "<string>",
  "bankName": "<string>",
  "currency": "<string>",
  "accountNumber": "<string>",
  "routingNumber": "<string>",
  "accountHolderName": "<string>",
  "accountHolderType": "individual",
  "metadata": {}
}'
{
  "id": "<string>",
  "object": "externalBankAccount",
  "organizationId": "<string>",
  "countryCode": "<string>",
  "bankName": "<string>",
  "currency": "<string>",
  "accountNumber": "<string>",
  "routingNumber": "<string>",
  "accountHolderName": "<string>",
  "accountHolderType": "individual",
  "last4": "<string>",
  "status": "pending",
  "metadata": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
organizationId
string
required

Unique identifier for an organization

countryCode
string
required
bankName
string
required
currency
string
required
accountNumber
string
required
routingNumber
string
required
accountHolderName
string
required
accountHolderType
enum<string>
required
Available options:
individual,
company
metadata
object

Response

201
application/json
External bank account created successfully
id
string
required

Unique identifier for the external bank account.

object
enum<string>
default:externalBankAccount
required

String representing the object's type.

Available options:
externalBankAccount
organizationId
string
required

The organization this bank account belongs to.

countryCode
string
required

Two-letter ISO country code.

bankName
string
required

Name of the bank.

currency
string
required

Three-letter ISO currency code.

accountHolderName
string
required

Name of the account holder.

accountHolderType
enum<string>
required

Type of the account holder.

Available options:
individual,
company
last4
string
required

Last 4 digits of the account number.

status
enum<string>
required

Current status of the bank account.

Available options:
pending,
verified,
failed
createdAt
string
required

Timestamp when the bank account was created.

updatedAt
string
required

Timestamp when the bank account was last updated.

accountNumber
string

Full account number (redacted in responses).

routingNumber
string

Bank routing number.

metadata
object

Additional metadata associated with the bank account.