Create a TED payment
curl --request POST \
--url https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/ted \
--header 'Content-Type: application/json' \
--data '
{
"amount": 235000,
"creditParty": {
"accountNumber": "0045671",
"accountType": "CACC",
"bankCode": "341",
"branch": "1234",
"document": "11222333000181",
"name": "Estúdio Lumen Fotografia Ltda"
},
"debitParty": {
"personName": "Mariana Souza Lima"
},
"description": "Ensaio fotográfico da campanha de novembro"
}
'import requests
url = "https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/ted"
payload = {
"amount": 235000,
"creditParty": {
"accountNumber": "0045671",
"accountType": "CACC",
"bankCode": "341",
"branch": "1234",
"document": "11222333000181",
"name": "Estúdio Lumen Fotografia Ltda"
},
"debitParty": { "personName": "Mariana Souza Lima" },
"description": "Ensaio fotográfico da campanha de novembro"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
amount: 235000,
creditParty: {
accountNumber: '0045671',
accountType: 'CACC',
bankCode: '341',
branch: '1234',
document: '11222333000181',
name: 'Estúdio Lumen Fotografia Ltda'
},
debitParty: {personName: 'Mariana Souza Lima'},
description: 'Ensaio fotográfico da campanha de novembro'
})
};
fetch('https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/ted', 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.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/ted",
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([
'amount' => 235000,
'creditParty' => [
'accountNumber' => '0045671',
'accountType' => 'CACC',
'bankCode' => '341',
'branch' => '1234',
'document' => '11222333000181',
'name' => 'Estúdio Lumen Fotografia Ltda'
],
'debitParty' => [
'personName' => 'Mariana Souza Lima'
],
'description' => 'Ensaio fotográfico da campanha de novembro'
]),
CURLOPT_HTTPHEADER => [
"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.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/ted"
payload := strings.NewReader("{\n \"amount\": 235000,\n \"creditParty\": {\n \"accountNumber\": \"0045671\",\n \"accountType\": \"CACC\",\n \"bankCode\": \"341\",\n \"branch\": \"1234\",\n \"document\": \"11222333000181\",\n \"name\": \"Estúdio Lumen Fotografia Ltda\"\n },\n \"debitParty\": {\n \"personName\": \"Mariana Souza Lima\"\n },\n \"description\": \"Ensaio fotográfico da campanha de novembro\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/ted")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 235000,\n \"creditParty\": {\n \"accountNumber\": \"0045671\",\n \"accountType\": \"CACC\",\n \"bankCode\": \"341\",\n \"branch\": \"1234\",\n \"document\": \"11222333000181\",\n \"name\": \"Estúdio Lumen Fotografia Ltda\"\n },\n \"debitParty\": {\n \"personName\": \"Mariana Souza Lima\"\n },\n \"description\": \"Ensaio fotográfico da campanha de novembro\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/ted")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 235000,\n \"creditParty\": {\n \"accountNumber\": \"0045671\",\n \"accountType\": \"CACC\",\n \"bankCode\": \"341\",\n \"branch\": \"1234\",\n \"document\": \"11222333000181\",\n \"name\": \"Estúdio Lumen Fotografia Ltda\"\n },\n \"debitParty\": {\n \"personName\": \"Mariana Souza Lima\"\n },\n \"description\": \"Ensaio fotográfico da campanha de novembro\"\n}"
response = http.request(request)
puts response.read_body{
"_id": "6728c4e1b4d3e80012c9a5b3",
"environment": "LIVE",
"realmId": "f495ff0c-ab54-4f99-8e92-ca8682e4de9b",
"organizationId": "c4bd3f21-dfbd-44e8-8055-68ba15bed410",
"accountId": "66f2a1c7b4d3e80012c9a0b4",
"walletId": "66f2a3d1b4d3e80012c9a0d2",
"creditParty": {
"_id": "6728c4e1b4d3e80012c9a5b4",
"accountNumber": "0045671",
"accountType": "CACC",
"bankCode": "341",
"branch": "1234",
"document": "11222333000181",
"name": "Estúdio Lumen Fotografia Ltda"
},
"debitParty": {
"_id": "6728c4e1b4d3e80012c9a5b5",
"personName": "Mariana Souza Lima"
},
"status": "REQUESTED",
"txnCurrency": "986",
"txnAmount": 235000,
"confirmedAmount": 0,
"createdAt": "2026-11-04T14:11:47.000Z",
"updatedAt": "2026-11-04T14:12:09.000Z",
"__v": 0,
"description": "Ensaio fotográfico da campanha de novembro",
"confirmedBalanceCategory": "FLEX_INTERNATIONAL",
"confirmedAt": "2026-11-04T14:12:09.000Z",
"canceledAt": "2026-11-04T14:15:02.000Z",
"refundedAt": "2026-11-05T10:47:22.000Z",
"external": {
"tedId": "5b0e7c9a-3f1d-4e2b-9a8c-7d6e5f4a3b2c"
}
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "FORBIDDEN_WALLET",
"origin": "BANKING",
"message": "You do not have permission to perform this action on this wallet"
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "ACCOUNT_NOT_FOUND",
"origin": "BANKING",
"message": "Account not found"
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "BAD_REQUEST",
"origin": "BANKING",
"message": "Bad Request: Your request is invalid or incomplete. Please make sure you are requesting with the right fields.",
"fields": [
{
"field": "amount",
"message": "Invalid input: expected integer, received undefined",
"code": "AMOUNT_REQUIRED"
}
]
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "BANKING_PROVIDER_INTEGRATION_ERROR",
"origin": "BANKING",
"message": "Too Many Requests"
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "BANKING_PROVIDER_UNAVAILABLE",
"origin": "BANKING",
"message": "Banking provider temporarily unavailable, please retry"
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "BANKING_PROVIDER_UNAVAILABLE",
"origin": "BANKING",
"message": "Banking provider temporarily unavailable, please retry"
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "BANKING_PROVIDER_UNAVAILABLE",
"origin": "BANKING",
"message": "Banking provider temporarily unavailable, please retry"
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "BANKING_PROVIDER_UNAVAILABLE",
"origin": "BANKING",
"message": "Banking provider temporarily unavailable, please retry"
}Create a TED payment
Creates a TED from the wallet to an account at another bank. Nothing is sent yet.
POST
/
realms
/
{realmId}
/
organizations
/
{organizationId}
/
accounts
/
{accountId}
/
wallets
/
{walletId}
/
ted
Create a TED payment
curl --request POST \
--url https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/ted \
--header 'Content-Type: application/json' \
--data '
{
"amount": 235000,
"creditParty": {
"accountNumber": "0045671",
"accountType": "CACC",
"bankCode": "341",
"branch": "1234",
"document": "11222333000181",
"name": "Estúdio Lumen Fotografia Ltda"
},
"debitParty": {
"personName": "Mariana Souza Lima"
},
"description": "Ensaio fotográfico da campanha de novembro"
}
'import requests
url = "https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/ted"
payload = {
"amount": 235000,
"creditParty": {
"accountNumber": "0045671",
"accountType": "CACC",
"bankCode": "341",
"branch": "1234",
"document": "11222333000181",
"name": "Estúdio Lumen Fotografia Ltda"
},
"debitParty": { "personName": "Mariana Souza Lima" },
"description": "Ensaio fotográfico da campanha de novembro"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
amount: 235000,
creditParty: {
accountNumber: '0045671',
accountType: 'CACC',
bankCode: '341',
branch: '1234',
document: '11222333000181',
name: 'Estúdio Lumen Fotografia Ltda'
},
debitParty: {personName: 'Mariana Souza Lima'},
description: 'Ensaio fotográfico da campanha de novembro'
})
};
fetch('https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/ted', 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.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/ted",
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([
'amount' => 235000,
'creditParty' => [
'accountNumber' => '0045671',
'accountType' => 'CACC',
'bankCode' => '341',
'branch' => '1234',
'document' => '11222333000181',
'name' => 'Estúdio Lumen Fotografia Ltda'
],
'debitParty' => [
'personName' => 'Mariana Souza Lima'
],
'description' => 'Ensaio fotográfico da campanha de novembro'
]),
CURLOPT_HTTPHEADER => [
"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.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/ted"
payload := strings.NewReader("{\n \"amount\": 235000,\n \"creditParty\": {\n \"accountNumber\": \"0045671\",\n \"accountType\": \"CACC\",\n \"bankCode\": \"341\",\n \"branch\": \"1234\",\n \"document\": \"11222333000181\",\n \"name\": \"Estúdio Lumen Fotografia Ltda\"\n },\n \"debitParty\": {\n \"personName\": \"Mariana Souza Lima\"\n },\n \"description\": \"Ensaio fotográfico da campanha de novembro\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/ted")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 235000,\n \"creditParty\": {\n \"accountNumber\": \"0045671\",\n \"accountType\": \"CACC\",\n \"bankCode\": \"341\",\n \"branch\": \"1234\",\n \"document\": \"11222333000181\",\n \"name\": \"Estúdio Lumen Fotografia Ltda\"\n },\n \"debitParty\": {\n \"personName\": \"Mariana Souza Lima\"\n },\n \"description\": \"Ensaio fotográfico da campanha de novembro\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/ted")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 235000,\n \"creditParty\": {\n \"accountNumber\": \"0045671\",\n \"accountType\": \"CACC\",\n \"bankCode\": \"341\",\n \"branch\": \"1234\",\n \"document\": \"11222333000181\",\n \"name\": \"Estúdio Lumen Fotografia Ltda\"\n },\n \"debitParty\": {\n \"personName\": \"Mariana Souza Lima\"\n },\n \"description\": \"Ensaio fotográfico da campanha de novembro\"\n}"
response = http.request(request)
puts response.read_body{
"_id": "6728c4e1b4d3e80012c9a5b3",
"environment": "LIVE",
"realmId": "f495ff0c-ab54-4f99-8e92-ca8682e4de9b",
"organizationId": "c4bd3f21-dfbd-44e8-8055-68ba15bed410",
"accountId": "66f2a1c7b4d3e80012c9a0b4",
"walletId": "66f2a3d1b4d3e80012c9a0d2",
"creditParty": {
"_id": "6728c4e1b4d3e80012c9a5b4",
"accountNumber": "0045671",
"accountType": "CACC",
"bankCode": "341",
"branch": "1234",
"document": "11222333000181",
"name": "Estúdio Lumen Fotografia Ltda"
},
"debitParty": {
"_id": "6728c4e1b4d3e80012c9a5b5",
"personName": "Mariana Souza Lima"
},
"status": "REQUESTED",
"txnCurrency": "986",
"txnAmount": 235000,
"confirmedAmount": 0,
"createdAt": "2026-11-04T14:11:47.000Z",
"updatedAt": "2026-11-04T14:12:09.000Z",
"__v": 0,
"description": "Ensaio fotográfico da campanha de novembro",
"confirmedBalanceCategory": "FLEX_INTERNATIONAL",
"confirmedAt": "2026-11-04T14:12:09.000Z",
"canceledAt": "2026-11-04T14:15:02.000Z",
"refundedAt": "2026-11-05T10:47:22.000Z",
"external": {
"tedId": "5b0e7c9a-3f1d-4e2b-9a8c-7d6e5f4a3b2c"
}
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "FORBIDDEN_WALLET",
"origin": "BANKING",
"message": "You do not have permission to perform this action on this wallet"
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "ACCOUNT_NOT_FOUND",
"origin": "BANKING",
"message": "Account not found"
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "BAD_REQUEST",
"origin": "BANKING",
"message": "Bad Request: Your request is invalid or incomplete. Please make sure you are requesting with the right fields.",
"fields": [
{
"field": "amount",
"message": "Invalid input: expected integer, received undefined",
"code": "AMOUNT_REQUIRED"
}
]
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "BANKING_PROVIDER_INTEGRATION_ERROR",
"origin": "BANKING",
"message": "Too Many Requests"
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "BANKING_PROVIDER_UNAVAILABLE",
"origin": "BANKING",
"message": "Banking provider temporarily unavailable, please retry"
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "BANKING_PROVIDER_UNAVAILABLE",
"origin": "BANKING",
"message": "Banking provider temporarily unavailable, please retry"
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "BANKING_PROVIDER_UNAVAILABLE",
"origin": "BANKING",
"message": "Banking provider temporarily unavailable, please retry"
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "BANKING_PROVIDER_UNAVAILABLE",
"origin": "BANKING",
"message": "Banking provider temporarily unavailable, please retry"
}Give the beneficiary’s bank details in
creditParty, the amount in centavos and, in debitParty, the name of the person making the transfer. The TED is created as REQUESTED: no money moves until you confirm it with POST .../ted/{tedId}/confirm, and you can cancel it until then. The bank details are not checked here — the bank checks them when you confirm. Use default as walletId for the organization’s main wallet.
You need permission to pay from the wallet: on the organization’s main wallet, be an admin of the organization or of the realm; on another wallet, be one of those admins or have it shared with you as OWNER or USER.Headers
Environment the TED is created in: LIVE (production) or TEST (sandbox). When you omit it, TEST is used; any other value is rejected.
Available options:
LIVE, TEST Path Parameters
ID of your realm.
Format: UUID
ID of the organization.
Format: UUID
ID of the organization's account (24 hexadecimal characters).
Pattern:
^[0-9a-fA-F]{24}$ID of the wallet the TED is sent from (24 hexadecimal characters), or default for the organization's main wallet.
Pattern:
^([0-9a-fA-F]{24}|default)$Body
application/json
Amount to send, in centavos (an integer of at least 1).
Required range:
x >= 1Example:
235000
The beneficiary: the account the TED is sent to.
Show child attributes
Show child attributes
Who is sending the TED.
Show child attributes
Show child attributes
A note kept with the TED and sent to the bank with it.
Example:
"Ensaio fotográfico da campanha de novembro"
Response
Successful response
A TED sent — or to be sent — from a wallet to an account at another bank.
ID of the TED. Use it as tedId to read, confirm or cancel it.
Example:
"6728c4e1b4d3e80012c9a5b3"
Environment of the TED.
Available options:
LIVE, TEST Example:
"LIVE"
ID of the realm.
Example:
"f495ff0c-ab54-4f99-8e92-ca8682e4de9b"
ID of the organization.
Example:
"c4bd3f21-dfbd-44e8-8055-68ba15bed410"
ID of the organization's account.
Example:
"66f2a1c7b4d3e80012c9a0b4"
ID of the wallet the TED is sent from — the wallet's own ID, also when you used the default alias.
Example:
"66f2a3d1b4d3e80012c9a0d2"
The account the TED is sent to.
Show child attributes
Show child attributes
Who sent the TED.
Show child attributes
Show child attributes
Where the TED is: REQUESTED (created, not sent yet — confirm or cancel it), PAID (the bank accepted it and the amount left the wallet), FAILED (the confirmation failed), CANCELLED (cancelled before it was sent) or REFUNDED (the bank returned the transfer and the amount came back to the wallet — usually a PAID TED, but a FAILED one whose confirmation timed out after the bank took it can end here too).
Available options:
REQUESTED, CANCELLED, PAID, FAILED, REFUNDED Example:
"REQUESTED"
Currency of the amounts, as its ISO 4217 numeric code — always 986 (Brazilian real).
Example:
"986"
Amount of the TED, in centavos.
Example:
235000
Amount that left the wallet, in centavos: equal to txnAmount once the TED is PAID, and 0 before. A few TEDs paid long ago carry 0 here too — for those, txnAmount is what was sent.
Example:
0
When the TED was created.
Example:
"2026-11-04T14:11:47.000Z"
When the TED last changed.
Example:
"2026-11-04T14:12:09.000Z"
Internal revision number of the record.
Example:
0
The note sent with the TED. Absent when none was given.
Example:
"Ensaio fotográfico da campanha de novembro"
Balance category of the wallet the amount was taken from. Set when the TED is paid — absent on a few TEDs paid long ago.
Available options:
FLEX_NATIONAL, FLEX_INTERNATIONAL, FOOD, GAS, MOBILITY, TOLL, FLEX_NATIONAL_WITHOUT_WITHDRAWALS, ADS, SAAS, HOTEL, AIRLINES, TRAVEL, BLOCKED, CASHBACK Example:
"FLEX_INTERNATIONAL"
When the TED was sent. Set when it is paid — absent on a few TEDs paid long ago.
Example:
"2026-11-04T14:12:09.000Z"
When the TED was cancelled. Set once it is CANCELLED.
Example:
"2026-11-04T14:15:02.000Z"
When the returned amount came back to the wallet. Set once the TED is REFUNDED.
Example:
"2026-11-05T10:47:22.000Z"
References of the TED at the bank. Set when the TED is paid and the bank identified it.
Show child attributes
Show child attributes