Quote the fee and total of a TED with no financial effect

curl --request POST \
  --url https://api.example.com/v1/transfers/fee-quotes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Account-Id: <x-account-id>' \
  --data '
{
  "amount": "1500.00",
  "purposeCode": "00010",
  "recipient": {
    "agency": "1234",
    "bankAccount": "0001234567",
    "bankAccountType": "CACC",
    "bankCode": "001",
    "document": "12345678901",
    "name": "Maria da Silva"
  }
}
'

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/transfers/fee-quotes"

	payload := strings.NewReader("{\n  \"amount\": \"1500.00\",\n  \"purposeCode\": \"00010\",\n  \"recipient\": {\n    \"agency\": \"1234\",\n    \"bankAccount\": \"0001234567\",\n    \"bankAccountType\": \"CACC\",\n    \"bankCode\": \"001\",\n    \"document\": \"12345678901\",\n    \"name\": \"Maria da Silva\"\n  }\n}")

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

	req.Header.Add("X-Account-Id", "<x-account-id>")
	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))

}

const options = {
  method: 'POST',
  headers: {
    'X-Account-Id': '<x-account-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    amount: '1500.00',
    purposeCode: '00010',
    recipient: {
      agency: '1234',
      bankAccount: '0001234567',
      bankAccountType: 'CACC',
      bankCode: '001',
      document: '12345678901',
      name: 'Maria da Silva'
    }
  })
};

fetch('https://api.example.com/v1/transfers/fee-quotes', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/v1/transfers/fee-quotes"

payload = {
    "amount": "1500.00",
    "purposeCode": "00010",
    "recipient": {
        "agency": "1234",
        "bankAccount": "0001234567",
        "bankAccountType": "CACC",
        "bankCode": "001",
        "document": "12345678901",
        "name": "Maria da Silva"
    }
}
headers = {
    "X-Account-Id": "<x-account-id>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "amount": "1500.00",
  "feeAmount": "3.25",
  "feePackageId": "7b8c9d0e-1f2a-4b3c-8d4e-5f6a7b8c9d0e",
  "quotedAt": "2026-10-22T13:05:12Z",
  "totalAmount": "1503.25",
  "type": "TED",
  "windowOpen": true
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Quote the fee and total of a TED with no financial effect

Calculates the fee and the total that this request would put on hold if you created the transfer now. It has no effect (it does not hold balance or limit). Send the same fields as the transfer creation and X-Account-Id with the source account.

The response tells you the path (type = TED or INTERNAL) and, if the window is closed, when it opens again (nextWindowOpensAt). The quote reflects the policy at the time of the query. The transfer creation calculates it again. Does not require X-Idempotency.

POST

transfers

fee-quotes

Quote the fee and total of a TED with no financial effect

curl --request POST \
  --url https://api.example.com/v1/transfers/fee-quotes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Account-Id: <x-account-id>' \
  --data '
{
  "amount": "1500.00",
  "purposeCode": "00010",
  "recipient": {
    "agency": "1234",
    "bankAccount": "0001234567",
    "bankAccountType": "CACC",
    "bankCode": "001",
    "document": "12345678901",
    "name": "Maria da Silva"
  }
}
'

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/transfers/fee-quotes"

	payload := strings.NewReader("{\n  \"amount\": \"1500.00\",\n  \"purposeCode\": \"00010\",\n  \"recipient\": {\n    \"agency\": \"1234\",\n    \"bankAccount\": \"0001234567\",\n    \"bankAccountType\": \"CACC\",\n    \"bankCode\": \"001\",\n    \"document\": \"12345678901\",\n    \"name\": \"Maria da Silva\"\n  }\n}")

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

	req.Header.Add("X-Account-Id", "<x-account-id>")
	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))

}

const options = {
  method: 'POST',
  headers: {
    'X-Account-Id': '<x-account-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    amount: '1500.00',
    purposeCode: '00010',
    recipient: {
      agency: '1234',
      bankAccount: '0001234567',
      bankAccountType: 'CACC',
      bankCode: '001',
      document: '12345678901',
      name: 'Maria da Silva'
    }
  })
};

fetch('https://api.example.com/v1/transfers/fee-quotes', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/v1/transfers/fee-quotes"

payload = {
    "amount": "1500.00",
    "purposeCode": "00010",
    "recipient": {
        "agency": "1234",
        "bankAccount": "0001234567",
        "bankAccountType": "CACC",
        "bankCode": "001",
        "document": "12345678901",
        "name": "Maria da Silva"
    }
}
headers = {
    "X-Account-Id": "<x-account-id>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "amount": "1500.00",
  "feeAmount": "3.25",
  "feePackageId": "7b8c9d0e-1f2a-4b3c-8d4e-5f6a7b8c9d0e",
  "quotedAt": "2026-10-22T13:05:12Z",
  "totalAmount": "1503.25",
  "type": "TED",
  "windowOpen": true
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Autorizaciones

Authorization

string

header

requerido

JWT token that the Lerian Access Manager issues for your institution. Send it in Authorization: Bearer <token> on every call (except the public health probes). The tenant never comes from the body, the query, or the path. Each operation requires a role with the matching permission (see the API overview). Without it, 403 TED-0071. Missing, invalid, or expired token: 401 TED-0070.

Encabezados

X-Account-Id

string<uuid>

requerido

Identifier (UUID) of the customer account in your own institution that starts the operation: the debited account in a send request or a quote. It goes in the header, never in the body. The account must belong to the organization that the token resolves. A missing or malformed value returns 400 TED-0008; an account from another organization returns 403 TED-0009.

X-Request-Id

string<uuid>

Correlation identifier of this request (UUID). Optional: when you omit it, or when the value is not a well-formed UUID, the platform creates a UUID and returns it in the X-Request-Id header of the response. The resolved identifier goes to the logs, spans, and audit events of this request. Keep it to open a support ticket.

Cuerpo

application/json

Quote request: the same financial fields as a send request (recipient, amount, and purpose code), with no effect.

amount

string

requerido

Amount in BRL as a decimal string, not a JSON number: digits only, with a dot as the decimal separator, up to 16 significant integer digits and at most 2 significant decimal places, with no sign or exponent. Leading and trailing spaces are ignored (e.g., "1500.00"; "1500.000" is equal to 1500.00).

Ejemplo:

"1500.00"

purposeCode

string

requerido

Purpose code of the TED (FinlddCli Domain Dictionary, 5 digits).

Pattern: ^[0-9]{5}$

Ejemplo:

"00001"

recipient

object

requerido

Recipient, exactly as it would be sent in the transfer request.

Show child attributes

Respuesta

Calculated quote: the feeAmount and totalAmount that this same request would put on hold now. No financial effect.

Quote result: the fee and total that the same request would put on hold at this instant, and whether the operating window is open. The quote does not hold balance or limit.

amount

string

requerido

Amount sent, in BRL.

Pattern: ^(0\.(0[1-9]|[1-9][0-9])|[1-9][0-9]{0,11}\.[0-9]{2})$

Ejemplo:

"1500.00"

feeAmount

string

requerido

Fee that a send request would hold now (0.00 when exempt).

Pattern: ^(0|[1-9][0-9]{0,11})\.[0-9]{2}$

Ejemplo:

"3.25"

quotedAt

string<date-time>

requerido

Time (UTC) of the quote.

totalAmount

string

requerido

Amount + fee: the total that would be debited from the source account.

Pattern: ^(0|[1-9][0-9]{0,11})\.[0-9]{2}$

Ejemplo:

"1503.25"

type

enum<string>

requerido

Path the send would take: TED (another institution, through the STR) or INTERNAL (your own institution, in the ledger).

Opciones disponibles:

TED,

INTERNAL

feePackageId

string

Identifier of the fee package applied in the ledger

nextWindowOpensAt

string<date-time>

Next opening of the effective window (UTC), given when the window is closed at this moment.

windowOpen

boolean

Whether the effective window is open at this moment. Missing when the window could not be read — it never means closed.

Resumen

API de Transferencias

API de TEDs recibidas

API de Conciliación

API de Operaciones

API de Políticas

API de Participantes

Manejo de errores

Quote the fee and total of a TED with no financial effect

Autorizaciones

Encabezados

Cuerpo

Respuesta