> ## Documentation Index > Fetch the complete documentation index at: https://developers.portao3.com.br/llms.txt > Use this file to discover all available pages before exploring further. # Create a TED payment > Creates a TED from the wallet to an account at another bank. Nothing is sent yet. 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`. ## OpenAPI ````yaml /api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/ted openapi: 3.0.3 info: title: Banking version: 1.0.0 description: >- Portão 3 banking API. Every endpoint requires a bearer token in the Authorization header (Authorization: Bearer ) unless its page states otherwise; see the Authentication guide. That requirement is not repeated per endpoint. Generated by tools/openapi from code (routes + security) and the hand-written spec (request/response bodies). Banking attaches a zod validationSchema at the route; request bodies are resolved from it (object + array roots). Responses have no presenter layer, so they stay tier=unknown. Confidence tiers: generated:typed=300 copied:manual=0 unknown=20. servers: - url: https://api.banking.v2.portao3.com.br/ description: production - url: https://api.banking.dev.3pers.com.br/ description: development security: [] tags: - name: Accounts - name: Account Limits - name: Wallets - name: Transaction Limits - name: Transfers - name: Cards - name: Card Limits - name: Cards 3DS - name: Pix Payments - name: Pix Keys - name: PIX Charges - name: PIX Automatic - name: PIX Initiation (Open Finance) - name: PIX Infractions (MED) - name: Boleto Payments - name: Boleto Charges - name: TED Payments - name: Transactions - name: Transaction Reversals - name: Spend Review - name: Cashback - name: Currency Codes paths: /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/ted: post: tags: - TED Payments summary: Create a TED payment description: >- Creates a TED from the wallet to an account at another bank. Nothing is sent yet. operationId: >- postRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdTed parameters: - name: realmId in: path required: true description: |- ID of your realm. Format: `UUID` schema: type: string format: uuid example: f495ff0c-ab54-4f99-8e92-ca8682e4de9b - name: organizationId in: path required: true description: |- ID of the organization. Format: `UUID` schema: type: string format: uuid example: c4bd3f21-dfbd-44e8-8055-68ba15bed410 - name: accountId in: path required: true description: ID of the organization's account (24 hexadecimal characters). schema: type: string pattern: ^[0-9a-fA-F]{24}$ example: 66f2a1c7b4d3e80012c9a0b4 - name: walletId in: path required: true description: >- ID of the wallet the TED is sent from (24 hexadecimal characters), or `default` for the organization's main wallet. schema: type: string pattern: ^([0-9a-fA-F]{24}|default)$ example: 66f2a3d1b4d3e80012c9a0d2 - name: x-environment in: header required: false description: >- Environment the TED is created in: `LIVE` (production) or `TEST` (sandbox). When you omit it, `TEST` is used; any other value is rejected. schema: type: string enum: - LIVE - TEST example: LIVE requestBody: required: true content: application/json: schema: type: object properties: amount: type: integer minimum: 1 description: Amount to send, in centavos (an integer of at least 1). example: 235000 description: description: A note kept with the TED and sent to the bank with it. example: Ensaio fotográfico da campanha de novembro type: string creditParty: type: object properties: accountNumber: type: string minLength: 1 pattern: ^[0-9]{5,}$ description: >- Number of the beneficiary's account, check digit included: digits only, at least 5, no hyphen. example: '0045671' accountType: type: string enum: - CACC - SVGS description: >- Type of the beneficiary's account: `CACC` (checking account) or `SVGS` (savings account). example: CACC bankCode: type: string minLength: 1 pattern: ^[0-9]{3}$ description: >- Three-digit code (COMPE) of the beneficiary's bank — `341`, `001`. Send it as a string to keep the leading zeros. example: '341' branch: type: string minLength: 1 pattern: ^[0-9]{4}$ description: >- Branch (agência) of the beneficiary's account: 4 digits, without its check digit. Send it as a string to keep the leading zeros. example: '1234' document: type: string minLength: 1 description: >- CPF (11 digits) or CNPJ (14 characters) of the account holder, with valid check digits. Punctuation is accepted and removed. example: '11222333000181' name: type: string minLength: 1 description: Name of the account holder. example: Estúdio Lumen Fotografia Ltda required: - accountNumber - accountType - bankCode - branch - document - name description: 'The beneficiary: the account the TED is sent to.' debitParty: type: object properties: personName: type: string minLength: 1 description: >- Name of the person making the TED on your side. It is sent to the bank with the transfer. example: Mariana Souza Lima required: - personName description: Who is sending the TED. required: - amount - creditParty - debitParty responses: '201': description: Successful response content: application/json: schema: type: object properties: _id: type: string description: >- ID of the TED. Use it as `tedId` to read, confirm or cancel it. example: 6728c4e1b4d3e80012c9a5b3 environment: type: string enum: - LIVE - TEST description: Environment of the TED. example: LIVE realmId: type: string description: ID of the realm. example: f495ff0c-ab54-4f99-8e92-ca8682e4de9b format: uuid organizationId: type: string description: ID of the organization. example: c4bd3f21-dfbd-44e8-8055-68ba15bed410 format: uuid accountId: type: string description: ID of the organization's account. example: 66f2a1c7b4d3e80012c9a0b4 walletId: type: string description: >- ID of the wallet the TED is sent from — the wallet's own ID, also when you used the `default` alias. example: 66f2a3d1b4d3e80012c9a0d2 creditParty: type: object properties: _id: type: string description: Internal identifier of this entry. example: 6728c4e1b4d3e80012c9a5b4 accountNumber: type: string description: >- Number of the beneficiary's account, check digit included, digits only. example: '0045671' accountType: type: string enum: - CACC - SVGS description: >- Type of the beneficiary's account: `CACC` (checking account) or `SVGS` (savings account). example: CACC bankCode: type: string description: Three-digit code (COMPE) of the beneficiary's bank. example: '341' branch: type: string description: >- Branch (agência) of the beneficiary's account, 4 digits. example: '1234' document: type: string description: >- CPF (11 digits) or CNPJ (14 characters) of the account holder, without punctuation. example: '11222333000181' name: type: string description: Name of the account holder. example: Estúdio Lumen Fotografia Ltda required: - _id - accountNumber - accountType - bankCode - branch - document - name description: The account the TED is sent to. debitParty: type: object properties: _id: type: string description: Internal identifier of this entry. example: 6728c4e1b4d3e80012c9a5b5 personName: type: string description: >- Name of the person who made the TED, as it was sent to the bank with the transfer. example: Mariana Souza Lima required: - _id - personName description: Who sent the TED. description: type: string description: The note sent with the TED. Absent when none was given. example: Ensaio fotográfico da campanha de novembro status: type: string enum: - REQUESTED - CANCELLED - PAID - FAILED - REFUNDED description: >- 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). example: REQUESTED txnCurrency: type: string description: >- Currency of the amounts, as its ISO 4217 numeric code — always `986` (Brazilian real). example: '986' txnAmount: type: number description: Amount of the TED, in centavos. example: 235000 confirmedAmount: type: number description: >- 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 confirmedBalanceCategory: type: string enum: - FLEX_NATIONAL - FLEX_INTERNATIONAL - FOOD - GAS - MOBILITY - TOLL - FLEX_NATIONAL_WITHOUT_WITHDRAWALS - ADS - SAAS - HOTEL - AIRLINES - TRAVEL - BLOCKED - CASHBACK description: >- Balance category of the wallet the amount was taken from. Set when the TED is paid — absent on a few TEDs paid long ago. example: FLEX_INTERNATIONAL confirmedAt: type: string description: >- 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' format: date-time canceledAt: type: string description: When the TED was cancelled. Set once it is `CANCELLED`. example: '2026-11-04T14:15:02.000Z' format: date-time refundedAt: type: string description: >- When the returned amount came back to the wallet. Set once the TED is `REFUNDED`. example: '2026-11-05T10:47:22.000Z' format: date-time external: type: object properties: tedId: type: string description: >- Identifier the bank gave the transfer. Set when the TED is paid. example: 5b0e7c9a-3f1d-4e2b-9a8c-7d6e5f4a3b2c description: >- References of the TED at the bank. Set when the TED is paid and the bank identified it. createdAt: type: string description: When the TED was created. example: '2026-11-04T14:11:47.000Z' format: date-time updatedAt: type: string description: When the TED last changed. example: '2026-11-04T14:12:09.000Z' format: date-time __v: type: number description: Internal revision number of the record. example: 0 required: - _id - environment - realmId - organizationId - accountId - walletId - creditParty - debitParty - status - txnCurrency - txnAmount - confirmedAmount - createdAt - updatedAt - __v description: >- A TED sent — or to be sent — from a wallet to an account at another bank. '403': description: >- `FORBIDDEN_WALLET` — You can't pay from this wallet: on the organization's main wallet you aren't an admin of the organization or of the realm; on another wallet you aren't one of those admins and it isn't shared with you as `OWNER` or `USER`. content: application/json: schema: type: object properties: traceId: type: string description: >- Identifier of the request that failed. Quote it when contacting support. example: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b code: type: string enum: - FORBIDDEN_WALLET description: >- Stable, machine-readable error code. Branch on this, never on `message`. origin: type: string enum: - BANKING description: Service that produced the error. message: type: string description: >- Human-readable explanation. Its wording may change without notice. required: - traceId - code - origin - message example: traceId: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b code: FORBIDDEN_WALLET origin: BANKING message: >- You do not have permission to perform this action on this wallet '404': description: >- `ACCOUNT_NOT_FOUND` — No account with this ID exists in the organization. `WALLET_NOT_FOUND` — No wallet with this ID exists in the account and environment — or, with `walletId` `default`, the account has no main wallet in this environment. content: application/json: schema: type: object properties: traceId: type: string description: >- Identifier of the request that failed. Quote it when contacting support. example: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b code: type: string enum: - ACCOUNT_NOT_FOUND - WALLET_NOT_FOUND description: >- Stable, machine-readable error code. Branch on this, never on `message`. origin: type: string enum: - BANKING description: Service that produced the error. message: type: string description: >- Human-readable explanation. Its wording may change without notice. required: - traceId - code - origin - message example: traceId: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b code: ACCOUNT_NOT_FOUND origin: BANKING message: Account not found '422': description: >- `BAD_REQUEST` — A path or body field is invalid — for example a `document` with wrong check digits, or a `bankCode` that isn't 3 digits; `fields` lists each one. content: application/json: schema: type: object properties: traceId: type: string description: >- Identifier of the request that failed. Quote it when contacting support. example: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b code: type: string enum: - BAD_REQUEST description: >- Stable, machine-readable error code. Branch on this, never on `message`. origin: type: string enum: - BANKING description: Service that produced the error. message: type: string description: >- Human-readable explanation. Its wording may change without notice. fields: type: array description: >- One entry per invalid request field (validation errors only). items: type: object properties: field: type: string description: >- Path of the invalid field, e.g. `label` or `values[0].value`. example: label message: type: string description: Why the field was rejected. example: label is required code: type: string description: >- `_` — e.g. `LABEL_REQUIRED`, `TYPE_ONE_OF`, `VALUES_VALUE_TYPE_ERROR`. example: LABEL_REQUIRED values: type: array items: type: string description: >- The accepted values, when the field is an enumeration. required: - field - message - code required: - traceId - code - origin - message example: 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 '429': description: >- `BANKING_PROVIDER_INTEGRATION_ERROR` — Too many requests reached the wallet's balance at once. Retry shortly. content: application/json: schema: type: object properties: traceId: type: string description: >- Identifier of the request that failed. Quote it when contacting support. example: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b code: type: string enum: - BANKING_PROVIDER_INTEGRATION_ERROR description: >- Stable, machine-readable error code. Branch on this, never on `message`. origin: type: string enum: - BANKING description: Service that produced the error. message: type: string description: >- Human-readable explanation. Its wording may change without notice. required: - traceId - code - origin - message example: traceId: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b code: BANKING_PROVIDER_INTEGRATION_ERROR origin: BANKING message: Too Many Requests '500': description: >- `BANKING_PROVIDER_UNAVAILABLE` — The bank failed, or didn't answer in time, while the wallet was being read. No TED was created — retry. content: application/json: schema: type: object properties: traceId: type: string description: >- Identifier of the request that failed. Quote it when contacting support. example: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b code: type: string enum: - BANKING_PROVIDER_UNAVAILABLE description: >- Stable, machine-readable error code. Branch on this, never on `message`. origin: type: string enum: - BANKING description: Service that produced the error. message: type: string description: >- Human-readable explanation. Its wording may change without notice. required: - traceId - code - origin - message example: traceId: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b code: BANKING_PROVIDER_UNAVAILABLE origin: BANKING message: Banking provider temporarily unavailable, please retry '502': description: >- `BANKING_PROVIDER_UNAVAILABLE` — The bank was unavailable while the wallet was being read. No TED was created — retry. content: application/json: schema: type: object properties: traceId: type: string description: >- Identifier of the request that failed. Quote it when contacting support. example: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b code: type: string enum: - BANKING_PROVIDER_UNAVAILABLE description: >- Stable, machine-readable error code. Branch on this, never on `message`. origin: type: string enum: - BANKING description: Service that produced the error. message: type: string description: >- Human-readable explanation. Its wording may change without notice. required: - traceId - code - origin - message example: traceId: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b code: BANKING_PROVIDER_UNAVAILABLE origin: BANKING message: Banking provider temporarily unavailable, please retry '503': description: >- `BANKING_PROVIDER_UNAVAILABLE` — The bank was unavailable while the wallet was being read. No TED was created — retry. content: application/json: schema: type: object properties: traceId: type: string description: >- Identifier of the request that failed. Quote it when contacting support. example: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b code: type: string enum: - BANKING_PROVIDER_UNAVAILABLE description: >- Stable, machine-readable error code. Branch on this, never on `message`. origin: type: string enum: - BANKING description: Service that produced the error. message: type: string description: >- Human-readable explanation. Its wording may change without notice. required: - traceId - code - origin - message example: traceId: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b code: BANKING_PROVIDER_UNAVAILABLE origin: BANKING message: Banking provider temporarily unavailable, please retry '504': description: >- `BANKING_PROVIDER_UNAVAILABLE` — The bank was unavailable while the wallet was being read. No TED was created — retry. content: application/json: schema: type: object properties: traceId: type: string description: >- Identifier of the request that failed. Quote it when contacting support. example: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b code: type: string enum: - BANKING_PROVIDER_UNAVAILABLE description: >- Stable, machine-readable error code. Branch on this, never on `message`. origin: type: string enum: - BANKING description: Service that produced the error. message: type: string description: >- Human-readable explanation. Its wording may change without notice. required: - traceId - code - origin - message example: traceId: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b code: BANKING_PROVIDER_UNAVAILABLE origin: BANKING message: Banking provider temporarily unavailable, please retry ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.