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
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
integration-key | string | Sim | Chave de integração. |
x-token | string | Sim | Token utilizado para autenticação. Pode ser encontrado no portal da API. |
Authorization | Auth Type Bearer Token | Sim | Inserir 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
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
first_name | string | Sim | Primeiro nome ou razão social do recebedor. |
last_name | string | Sim | Sobrenome ou nome fantasia. |
document | string | Sim | CPF ou CNPJ do recebedor. |
phone_number | string | Sim | Telefone do recebedor. |
email | string | Sim | E-mail do recebedor. |
bank_account | object | Sim | Dados bancários do recebedor. |
recipient | object | Sim | Dados da transferência. |
🏦 Objeto bank_account
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
bank_code | string | Sim | Código do banco (3 dígitos). |
routing_number | string | Sim | Número da agência (sem dígito). |
routing_check_digit | string | Não | Dígito da agência. |
account_number | string | Sim | Número da conta. |
account_check_digit | string | Sim | Dígito da conta. |
type | string | Sim | Tipo da conta (CHECKING ou SAVINGS). |
💰 Objeto recipient
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
amount | number | Sim | Valor da transferência em centavos. |
expected_at | string | Não | Data 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
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
_id | string | Sim | ID da transferência. |
type | string | Sim | Tipo (TED). |
status | string | Sim | Status atual da transferência. CREATED, PENDING, PAID, FAILED, REFUNDED, CANCELED, PROCESSING |
amount | number | Sim | Valor transferido (centavos). |
original_amount | number | Não | Valor original da transferência. |
establishment_id | string | Sim | ID do estabelecimento. |
gateway_key | string | Não | Código do gateway. |
gateway_authorization | string | Sim | Código de autorização. |
expected_at | string | Sim | Data prevista de liquidação. |
recipient | object | Sim | Conta recebedora. |
payer | object | Sim | Conta pagadora. |
history | array | Sim | Histórico de status. |
method | string | Sim | Direção (OUT). |
end_to_end | string | Não | Identificador da transação. |
description | string | Não | Descrição da transferência. |
reprocessed | boolean | Sim | Indica reprocessamento. |
created_at | string | Sim | Data de criação. |
updated_at | string | Sim | Data de atualização. |
fees | number | Não | Total de taxas. |
user | object | Não | Usuário responsável pela ação. |
👤 Objeto recipient (Conta destino)
| Campo | Tipo | Descrição |
|---|---|---|
document | string | Documento do titular. |
bank_code | string | Código do banco. |
bank_name | string | Nome do banco. |
routing_number | string | Agência. |
account_number | string | Conta. |
account_check_digit | string | Dígito da conta. |
type | string | Tipo da conta. |
🏦 Objeto payer (Conta origem)
| Campo | Tipo | Descrição |
|---|---|---|
bank_code | string | Código do banco. |
bank_name | string | Nome do banco. |
routing_number | string | Agência. |
account_number | string | Conta. |
account_check_digit | string | Dígito da conta. |
type | string | Tipo da conta. |
🧾 Objeto history
| Campo | Tipo | Descrição |
|---|---|---|
status | string | Status da transferência. |
created_at | string | Data do evento. |
_id | string | ID 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-outou 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.
Updated 3 months ago
Did this page help you?