Skip to main content
POST
/
v1
/
external_accounts
Create an external account
curl --request POST \
  --url https://api.yorlet.com/v1/external_accounts \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "attach": {
    "owner": "<string>"
  },
  "bank_account": {
    "account_holder_name": "<string>",
    "country": "<string>",
    "account_number": "<string>",
    "swift_bic": "<string>",
    "routing_number": "<string>"
  },
  "type": "bank_account",
  "metadata": {}
}
'
{
  "id": "<string>",
  "created": 123,
  "object": "external_account",
  "available_payout_methods": [
    "<string>"
  ],
  "confirmation_of_payee": {},
  "type": "bank_account",
  "account": "<string>",
  "deleted": false,
  "bank_account": {
    "account_holder_name": "<string>",
    "bank_name": "<string>",
    "country": "<string>",
    "last4": "<string>",
    "routing_number": "<string>",
    "swift_bic": "<string>"
  },
  "metadata": {}
}

Authorizations

​
Authorization
string
header
required

API Key authentication. Use "Bearer YOUR_API_KEY".

Body

application/json
​
attach
object
required

The entity to attach the external account to.

​
bank_account
object
required

Bank account details for the external account.

​
type
enum<string>
required

The type of external account to create.

Available options:
bank_account
​
metadata
object

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

Response

200 - application/json

Returns the external account object if the request succeeded.

​
id
string
required

Unique identifier for the object.

​
created
number
required

Time at which the object was created. Measured in seconds since the Unix epoch.

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

The payout methods supported by this external account.

​
confirmation_of_payee
object
required

Confirmation of payee status for the external account.

​
status
enum<string>
required

The status of the external account.

Available options:
new,
errored
​
type
enum<string>
required

The type of the external account.

Available options:
bank_account
​
account
string

The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.

​
deleted
boolean
default:false

Only returned if the object has been deleted.

​
bank_account
object

Bank account details when the external account type is bank_account.

​
metadata
object

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.