v1

latestOpenAPI 3.0.12026-07-261451591021.8 KB
Pagamentos

Realizar a criação de uma transação TED ou TEI

Pagamento - Criação de Transação TED ou TEI<br/>Permite que usuários autorizados iniciem e registrem transações financeiras, tanto TED (Transferência Eletrônica Disponível) entre bancos quanto TEI (Transferência Eletrônica Interna) dentro do mesmo banco. Esta API facilita o processamento ágil e eficiente de pagamentos, assegurando o cumprimento pontual das obrigações financeiras e promovendo maior transparência nas transações.<br/><br/>Requisição<br/><table><thead><tr><th>Campo</th><th>Tipo</th><th>Descrição</th><th>Obrigatoriedade</th></tr></thead><tbody><tr><td>cpfOperador</td><td>Texto</td><td>CPF do operador cadastrado na plataforma.</td><td>Sim</td></tr><tr><td>contaOrigem</td><td>Texto</td><td>Conta da qual se origina o pagamento com o digito verificador.</td><td>Sim</td></tr><tr><td>senhaMovimentacao</td><td>Texto</td><td>Senha de movimentação do operador utilizada na plataforma de pagamento</td><td>Sim</td></tr><tr><td>bankCode</td><td>Texto</td><td>Código de banco</td><td>Sim</td></tr><tr><td>bankName</td><td>Texto</td><td>Nome do banco</td><td>Sim</td></tr><tr><td>agency</td><td>Texto</td><td>Número da agência destino</td><td>Sim</td></tr><tr><td>agencyCode</td><td>Texto</td><td>Número verificador da agência destino</td><td>Sim</td></tr><tr><td>account</td><td>Texto</td><td>Número da conta destino</td><td>Sim</td></tr><tr><td>accountCode</td><td>Texto</td><td>Número verificador da conta destino</td><td>Sim</td></tr><tr><td>documentNumber</td><td>Texto</td><td>Cpf ou cnpj destinatário</td><td>Sim</td></tr><tr><td>name</td><td>Texto</td><td>Nome do destinatário</td><td>Sim</td></tr><tr><td>amount</td><td>Texto</td><td>Valor a ser transferido</td><td>Sim</td></tr><tr><td>dataAgendamento</td><td>Texto</td><td>Data do agendamento do pagamento</td><td>Não</td></tr></tbody></table><br/><br/>Resposta<br/><table><thead><tr><th>Campo</th><th>Tipo</th><th>Descrição</th></tr></thead><tbody><tr><td>message</td><td>Texto</td><td>Mensagem para comprovação do pagamento</td></tr><tr><td>Data - transaction</td><td>Texto</td><td>Código da transação</td></tr></tbody></table>

post/api/v1/pagamento/ted

Headers

client-idstring uuid required
Example:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Client ID enviado no Header

Request body

cpfOperadorstring
contaOrigemstring
senhaMovimentacaostring
bankCodestring
bankNamestring
agencystring
agencyCodestring
accountstring
accountCodestring
documentNumberstring
namestring
amountstring
dataAgendamentostring

Example request

{
  "cpfOperador": "00000000000",
  "contaOrigem": "0550000000",
  "senhaMovimentacao": "******",
  "bankCode": "0001",
  "bankName": "BANCO TESTE S.A.",
  "agency": "0000",
  "agencyCode": "1",
  "account": "00000",
  "accountCode": "1",
  "documentNumber": "000.000.000-00",
  "name": "Fulano de Tal",
  "amount": "0.01",
  "dataAgendamento": "YYYY-mm-dd"
}

Response

Transação enviada para aprovação.

messagestring

Example response

{
  "message": "Transação enviada para aprovação.",
  "data": [
    {
      "transaction": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    }
  ]
}