Create an external account
Create a new 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": {}
}
'import requests
url = "https://api.yorlet.com/v1/external_accounts"
payload = {
"attach": { "owner": "<string>" },
"bank_account": {
"account_holder_name": "<string>",
"country": "<string>",
"account_number": "<string>",
"swift_bic": "<string>",
"routing_number": "<string>"
},
"type": "bank_account",
"metadata": {}
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
attach: {owner: '<string>'},
bank_account: {
account_holder_name: '<string>',
country: '<string>',
account_number: '<string>',
swift_bic: '<string>',
routing_number: '<string>'
},
type: 'bank_account',
metadata: {}
})
};
fetch('https://api.yorlet.com/v1/external_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.yorlet.com/v1/external_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([
'attach' => [
'owner' => '<string>'
],
'bank_account' => [
'account_holder_name' => '<string>',
'country' => '<string>',
'account_number' => '<string>',
'swift_bic' => '<string>',
'routing_number' => '<string>'
],
'type' => 'bank_account',
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$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.yorlet.com/v1/external_accounts"
payload := strings.NewReader("{\n \"attach\": {\n \"owner\": \"<string>\"\n },\n \"bank_account\": {\n \"account_holder_name\": \"<string>\",\n \"country\": \"<string>\",\n \"account_number\": \"<string>\",\n \"swift_bic\": \"<string>\",\n \"routing_number\": \"<string>\"\n },\n \"type\": \"bank_account\",\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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.yorlet.com/v1/external_accounts")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"attach\": {\n \"owner\": \"<string>\"\n },\n \"bank_account\": {\n \"account_holder_name\": \"<string>\",\n \"country\": \"<string>\",\n \"account_number\": \"<string>\",\n \"swift_bic\": \"<string>\",\n \"routing_number\": \"<string>\"\n },\n \"type\": \"bank_account\",\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.yorlet.com/v1/external_accounts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"attach\": {\n \"owner\": \"<string>\"\n },\n \"bank_account\": {\n \"account_holder_name\": \"<string>\",\n \"country\": \"<string>\",\n \"account_number\": \"<string>\",\n \"swift_bic\": \"<string>\",\n \"routing_number\": \"<string>\"\n },\n \"type\": \"bank_account\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"created": 123,
"object": "external_account",
"available_payout_methods": [
"<string>"
],
"confirmation_of_payee": {
"status": "awaiting_acknowledgement"
},
"status": "new",
"type": "bank_account",
"account": "<string>",
"deleted": false,
"bank_account": {
"account_holder_name": "<string>",
"account_holder_type": "individual",
"bank_name": "<string>",
"country": "<string>",
"currency": "aud",
"last4": "<string>",
"routing_number": "<string>",
"account_number": "<string>",
"swift_bic": "<string>"
},
"metadata": {}
}Authorizations
API Key authentication. Use "Bearer YOUR_API_KEY".
Body
The entity to attach the external account to.
Show child attributes
Show child attributes
Bank account details for the external account.
Show child attributes
Show child attributes
The type of external account to create.
bank_account 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.
Show child attributes
Show child attributes
Response
Returns the external account object if the request succeeded.
Unique identifier for the object.
Time at which the object was created. Measured in seconds since the Unix epoch.
external_account The payout methods supported by this external account.
Confirmation of payee status for the external account.
Show child attributes
Show child attributes
The status of the external account.
new, errored The type of the external account.
bank_account The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.
Only returned if the object has been deleted.
Bank account details when the external account type is bank_account.
Show child attributes
Show child attributes
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.
Show child attributes
Show child attributes
Was this page helpful?
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": {}
}
'import requests
url = "https://api.yorlet.com/v1/external_accounts"
payload = {
"attach": { "owner": "<string>" },
"bank_account": {
"account_holder_name": "<string>",
"country": "<string>",
"account_number": "<string>",
"swift_bic": "<string>",
"routing_number": "<string>"
},
"type": "bank_account",
"metadata": {}
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
attach: {owner: '<string>'},
bank_account: {
account_holder_name: '<string>',
country: '<string>',
account_number: '<string>',
swift_bic: '<string>',
routing_number: '<string>'
},
type: 'bank_account',
metadata: {}
})
};
fetch('https://api.yorlet.com/v1/external_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.yorlet.com/v1/external_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([
'attach' => [
'owner' => '<string>'
],
'bank_account' => [
'account_holder_name' => '<string>',
'country' => '<string>',
'account_number' => '<string>',
'swift_bic' => '<string>',
'routing_number' => '<string>'
],
'type' => 'bank_account',
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$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.yorlet.com/v1/external_accounts"
payload := strings.NewReader("{\n \"attach\": {\n \"owner\": \"<string>\"\n },\n \"bank_account\": {\n \"account_holder_name\": \"<string>\",\n \"country\": \"<string>\",\n \"account_number\": \"<string>\",\n \"swift_bic\": \"<string>\",\n \"routing_number\": \"<string>\"\n },\n \"type\": \"bank_account\",\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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.yorlet.com/v1/external_accounts")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"attach\": {\n \"owner\": \"<string>\"\n },\n \"bank_account\": {\n \"account_holder_name\": \"<string>\",\n \"country\": \"<string>\",\n \"account_number\": \"<string>\",\n \"swift_bic\": \"<string>\",\n \"routing_number\": \"<string>\"\n },\n \"type\": \"bank_account\",\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.yorlet.com/v1/external_accounts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"attach\": {\n \"owner\": \"<string>\"\n },\n \"bank_account\": {\n \"account_holder_name\": \"<string>\",\n \"country\": \"<string>\",\n \"account_number\": \"<string>\",\n \"swift_bic\": \"<string>\",\n \"routing_number\": \"<string>\"\n },\n \"type\": \"bank_account\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"created": 123,
"object": "external_account",
"available_payout_methods": [
"<string>"
],
"confirmation_of_payee": {
"status": "awaiting_acknowledgement"
},
"status": "new",
"type": "bank_account",
"account": "<string>",
"deleted": false,
"bank_account": {
"account_holder_name": "<string>",
"account_holder_type": "individual",
"bank_name": "<string>",
"country": "<string>",
"currency": "aud",
"last4": "<string>",
"routing_number": "<string>",
"account_number": "<string>",
"swift_bic": "<string>"
},
"metadata": {}
}