Create a new bank account.

curl --request POST \
  --url https://api.sandbox.tesouro.com/embedded-banking/v1/bank-accounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "nickname": "<string>",
  "bankAccountNumber": "<string>",
  "bankAccountReference": "<string>",
  "beneficialOwnerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://api.sandbox.tesouro.com/embedded-banking/v1/bank-accounts"

payload = {
    "nickname": "<string>",
    "bankAccountNumber": "<string>",
    "bankAccountReference": "<string>",
    "beneficialOwnerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    nickname: '<string>',
    bankAccountNumber: '<string>',
    bankAccountReference: '<string>',
    beneficialOwnerId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://api.sandbox.tesouro.com/embedded-banking/v1/bank-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.sandbox.tesouro.com/embedded-banking/v1/bank-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([
    'nickname' => '<string>',
    'bankAccountNumber' => '<string>',
    'bankAccountReference' => '<string>',
    'beneficialOwnerId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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.sandbox.tesouro.com/embedded-banking/v1/bank-accounts"

	payload := strings.NewReader("{\n  \"nickname\": \"<string>\",\n  \"bankAccountNumber\": \"<string>\",\n  \"bankAccountReference\": \"<string>\",\n  \"beneficialOwnerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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.sandbox.tesouro.com/embedded-banking/v1/bank-accounts")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"nickname\": \"<string>\",\n  \"bankAccountNumber\": \"<string>\",\n  \"bankAccountReference\": \"<string>\",\n  \"beneficialOwnerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.tesouro.com/embedded-banking/v1/bank-accounts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"nickname\": \"<string>\",\n  \"bankAccountNumber\": \"<string>\",\n  \"bankAccountReference\": \"<string>\",\n  \"beneficialOwnerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "accountNumber": "<string>",
  "createdDateTime": "2023-11-07T05:31:56Z",
  "routingNumber": "<string>",
  "bankAccountReference": "<string>",
  "nickname": "<string>"
}

{
  "detail": "<string>",
  "errorCode": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "detail": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "detail": "<string>",
  "errorCode": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

POST

embedded-banking

bank-accounts

Create a new bank account.

curl --request POST \
  --url https://api.sandbox.tesouro.com/embedded-banking/v1/bank-accounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "nickname": "<string>",
  "bankAccountNumber": "<string>",
  "bankAccountReference": "<string>",
  "beneficialOwnerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://api.sandbox.tesouro.com/embedded-banking/v1/bank-accounts"

payload = {
    "nickname": "<string>",
    "bankAccountNumber": "<string>",
    "bankAccountReference": "<string>",
    "beneficialOwnerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    nickname: '<string>',
    bankAccountNumber: '<string>',
    bankAccountReference: '<string>',
    beneficialOwnerId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://api.sandbox.tesouro.com/embedded-banking/v1/bank-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.sandbox.tesouro.com/embedded-banking/v1/bank-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([
    'nickname' => '<string>',
    'bankAccountNumber' => '<string>',
    'bankAccountReference' => '<string>',
    'beneficialOwnerId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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.sandbox.tesouro.com/embedded-banking/v1/bank-accounts"

	payload := strings.NewReader("{\n  \"nickname\": \"<string>\",\n  \"bankAccountNumber\": \"<string>\",\n  \"bankAccountReference\": \"<string>\",\n  \"beneficialOwnerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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.sandbox.tesouro.com/embedded-banking/v1/bank-accounts")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"nickname\": \"<string>\",\n  \"bankAccountNumber\": \"<string>\",\n  \"bankAccountReference\": \"<string>\",\n  \"beneficialOwnerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.tesouro.com/embedded-banking/v1/bank-accounts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"nickname\": \"<string>\",\n  \"bankAccountNumber\": \"<string>\",\n  \"bankAccountReference\": \"<string>\",\n  \"beneficialOwnerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "accountNumber": "<string>",
  "createdDateTime": "2023-11-07T05:31:56Z",
  "routingNumber": "<string>",
  "bankAccountReference": "<string>",
  "nickname": "<string>"
}

{
  "detail": "<string>",
  "errorCode": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "detail": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

{
  "detail": "<string>",
  "errorCode": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>"
}

Authorizations

Authorization

string

header

required

Application (M2M) OAuth2 access token (client credentials).

Headers

X-Organization-ID

string<uuid>

ID of the organization to perform this operation on behalf of. Required for BANK and PLATFORM app token callers targeting a specific organization. If omitted, the request uses the authenticated caller's own organization. Must be a valid non-empty UUID. Present but malformed values return 400.

Body

Request model for creating a new bank account.

nickname

string

required

The nickname for the new bank account.

bankAccountNumber

null | string

An optional bank account number to assign to the new account. When omitted, Tesouro generates one. Only available to providers explicitly approved by the bank; the value is validated against the bank's account number rules and rejected if it does not conform.

bankAccountReference

null | string

An optional reference identifier to associate with the bank account. Can be used to store a Platform's or VSP's internal account identifier. Must be alphanumeric (letters, numbers, hyphens, underscores, and dots) and max 50 characters.

beneficialOwnerId

null | string<uuid>

The ID of a beneficial owner to use for VSP APP token bank account creation. Required for VSP APP token callers (no user context). Not applicable when organizationId is provided by BANK or PLATFORM callers.

Response

Bank account created successfully.

Response model for a bank account.

string<uuid>

required

Unique identifier for the bank account.

accountNumber

string

required

Masked account number.

createdDateTime

string<date-time>

required

The UTC timestamp when the bank account was created.

routingNumber

string

required

Bank routing number.

status

enum<string>

required

The status of the bank account.

Available options:

ACTIVE,

CLOSED

bankAccountReference

null | string

Reference identifier associated with the bank account.

nickname

null | string

Nickname for the bank account.

Get all bank accounts with balances.Get a bank account by ID.

⌘I

Applications

Bank Accounts

Bank Account Access

Beneficial Owners

Disclosures

External Bank Accounts

MoneyMovements

Organization

Identity

Create a new bank account.

Authorizations

Headers

Body

Response