Criar transferência TED

Esta rota permite realizar transferências bancárias via TED para contas de terceiros. A operação cria uma instrução de transferência a partir de um estabelecimento do marketplace para uma conta bancária externa.


🔼

POST urlServidor/v1/marketplace/banking/transfers/ted

Obs: A palavra urlServidor deve ser substituída pela url do servidor.

Parâmetros da Requisição

NomeTipoObrigatórioDescrição
integration-keystringSimChave de integração.
x-tokenstringSimToken utilizado para autenticação. Pode ser encontrado no portal da API.
AuthorizationAuth Type Bearer TokenSimInserir o Bearer Token, gerado na rota Auth

Exemplo de header da requisição

curl--request POST \
--location 'urlServidor/v1/marketplace/banking/transfers/ted' \
--header 'integration-key: your_integration_key' \
--header 'x-token: your_x_token' \
--header 'Authorization: Bearer {{bearer_token}}' \

Variáveis

Objeto CreateTransferTedDto

CampoTipoObrigatórioDescrição
first_namestringSimPrimeiro nome ou razão social do recebedor.
last_namestringSimSobrenome ou nome fantasia.
documentstringSimCPF ou CNPJ do recebedor.
phone_numberstringSimTelefone do recebedor.
emailstringSimE-mail do recebedor.
bank_accountobjectSimDados bancários do recebedor.
recipientobjectSimDados da transferência.

🏦 Objeto bank_account

CampoTipoObrigatórioDescrição
bank_codestringSimCódigo do banco (3 dígitos).
routing_numberstringSimNúmero da agência (sem dígito).
routing_check_digitstringNãoDígito da agência.
account_numberstringSimNúmero da conta.
account_check_digitstringSimDígito da conta.
typestringSimTipo da conta (CHECKING ou SAVINGS).

💰 Objeto recipient

CampoTipoObrigatórioDescrição
amountnumberSimValor da transferência em centavos.
expected_atstringNãoData prevista para execução da transferência.

📥 Modelo body

{
  "first_name": "João",
  "last_name": "Silva",
  "document": "93133206060",
  "phone_number": "27999999999",
  "email": "[email protected]",
  "bank_account": {
        "account_check_digit": "2",
        "account_number": "14548754",
        "bank_code": "246",
        "routing_number": "4587",
        "routing_check_digit": "1",
        "type": "CHECKING",
        "main": true
    },
  "recipient": {
    "amount": 10000,
    "expected_at": "20260415"
  }
}

📥 Detalhe Response

Objeto TransferResponse

CampoTipoObrigatórioDescrição
_idstringSimID da transferência.
typestringSimTipo (TED).
statusstringSimStatus atual da transferência. CREATED, PENDING, PAID, FAILED, REFUNDED, CANCELED, PROCESSING
amountnumberSimValor transferido (centavos).
original_amountnumberNãoValor original da transferência.
establishment_idstringSimID do estabelecimento.
gateway_keystringNãoCódigo do gateway.
gateway_authorizationstringSimCódigo de autorização.
expected_atstringSimData prevista de liquidação.
recipientobjectSimConta recebedora.
payerobjectSimConta pagadora.
historyarraySimHistórico de status.
methodstringSimDireção (OUT).
end_to_endstringNãoIdentificador da transação.
descriptionstringNãoDescrição da transferência.
reprocessedbooleanSimIndica reprocessamento.
created_atstringSimData de criação.
updated_atstringSimData de atualização.
feesnumberNãoTotal de taxas.
userobjectNãoUsuário responsável pela ação.

👤 Objeto recipient (Conta destino)

CampoTipoDescrição
documentstringDocumento do titular.
bank_codestringCódigo do banco.
bank_namestringNome do banco.
routing_numberstringAgência.
account_numberstringConta.
account_check_digitstringDígito da conta.
typestringTipo da conta.

🏦 Objeto payer (Conta origem)

CampoTipoDescrição
bank_codestringCódigo do banco.
bank_namestringNome do banco.
routing_numberstringAgência.
account_numberstringConta.
account_check_digitstringDígito da conta.
typestringTipo da conta.

🧾 Objeto history

CampoTipoDescrição
statusstringStatus da transferência.
created_atstringData do evento.
_idstringID do histórico.

⚠️ Observações importantes

  • O valor deve ser informado em centavos.
  • A TED depende do horário bancário para liquidação.
  • O status inicial será CREATED ou PROCESSING.
  • A confirmação da liquidação deve ser feita via webhook new-transfer-ted-out ou consulta posterior.
  • Campos como fees podem variar conforme configuração do parceiro.

⚠️

Registro de logs

É obrigatório manter registros em logs de todas as validações de OTP realizadas. A Paytime pode solicitar, a qualquer momento, relatórios e evidências desses logs para fins de auditoria e comprovação de segurança em movimentações financeiras.


Códigos de resposta

Consulte a página com os status: Status de respostas

Para mais detalhes sobre os parâmetros e funcionamento da API, acesse a documentação oficial da Paytime.



Did this page help you?