TED

Realizar TED

O recebimento de uma transação TED não é instantânea no sistema financeiro nacional. Ao realizar uma transação TED no sistema QI uma resposta imediata será retornada informando erro, rejeição ou aceite da transferencia. Mesmo que uma transferência tenha sido colocada em sent, a Instituição Financeira recebedora pode recusar a entrada de recurso e realizar a devolução do valor. Neste caso um novo webhook com status de rejected será enviado e o motivo da rejeição retornado no campo refusal_reason.

Débitos na conta fonte da transação serão realizados imediatamente. Isso não significa que o valor foi creditado na conta destino devido aos princípios de transações TED descritos acima. Caso ocorra a rejeição da transação enviada, o valor da transação será creditado novamente à conta fonte.

Request

ENDPOINT

/account/ACCOUNT_KEY/ted

MÉTODO

POST

Request Body

{
  "target_account": {
    "account_branch": "0001",
    "account_number": "92796",
    "account_digit": "1",
    "owner_document_number": "23599885000192",
    "owner_name": "Titular da Conta",
    "ispb": "12345678",
    "account_type": "checking_account"
  },
  "transaction_amount": 8.86,
  "request_control_key": "048c8ee5-1c91-46a6-952e-7e5c27c21f20"
}

BODY PARAMS

Campo	Tipo	Descrição	Caracteres
request_control_key *	string	Chave única de identificação da request utilizada pelo cliente no formato uuid v4.	36
target_account *	object	Conta de destino	Objeto target_account
transaction_amount *	float	Valor da transferência	10

Objeto target_account

Campo	Tipo	Descrição	Caracteres
account_branch *	string	Agência.	4
account_digit *	string	Dígito da conta	1
account_number *	string	Número da conta.	20
owner_document_number *	string	CPF ou CNPJ (apenas números) do titular da conta.	14
owner_name *	string	Nome do titular da conta.	50
account_type*	string	Tipo da conta.	Enumerador account_type
ispb *	string	Base no CNPJ da instituição financeira (8 dígitos).	8

Enumerador account_type

Enumerador	Tradução
checking_account	conta corrente
deposit_account	conta depósito
guaranteed_account	conta de garantia
investment_account	conta de investimento
payment_account	conta de pagamento
saving_account	conta poupança

Response

STATUS

201

Response Body

{
  "request_control_key": "6e290347-330d-4b3a-8ebb-2ac217ad6eb3",
  "ted_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
  "created_at": "2021-10-22T20:30:23.459Z",
  "ted_status": "sent",
  "transaction_amount": 126.97,
  "fee_amount": 0.0,
  "transaction_key": "8ea90347-330d-4b3a-8ebb-2ac217ad6eb3"
}

STATUS

4xx

Response Body: Error

{
  "title": "titulo",
  "description": "description in English",
  "translation": "descrição em portugues",
  "code": "codigo",
  "extra_fields": {}
}

Código HTTP status	Código QI code	Título title	Descrição (eng) description	Descrição (ptbr) translation
400	QIT000001	Bad Request	Schema Error	Erro de Schema
400	TED000XXX	request_control_key must be a valid uuid v4 string	request_control_key was not accepted for not being a valid uuid v4 string	request_control_key não foi aceito por não ser uma palavra uuid v4 válida
400	TED000XXX	Invalid Transaction Amount	Transaction amount of {transaction_amount} is not valid. It must be a positive value with at maximum 2 decimal places	O valor de transação {transaction_amount} não é válido. Deve ser um valor positivo com no máximo duas casas decimais
404	TED000XXX	Account not found	Account not found for: {account_datum}	Conta não encontrada para: {account_datum}
400	TED000XXX	Account is Closed	Account {account_key} is closed.	Conta {account_key} está fechada.
400	TED000XXX	Account is Blocked	Account {account_key} is blocked.	Conta {account_key} está bloqueada.
403	TED000XXX	User is not allowed to do this transaction		Usuário não tem autorização para fazer essa transação
400	TED000XXX	Target Account may not receive resources	Target account is currently unavailable o receive resorses	Conta destino está impedida de receber recursos
400	TED000XXX	Bad Request	Insufficient account balance for transfer and fee amount.	Saldo de conta insuficiente para a transferência e a taxa.
400	TED000XXX	Bad Request	Billing account closed or blocked	Conta de cobrança encerrada ou bloqueada
400	TED000XXX	Bad Request	Insufficient billing account balance for fee.	Saldo de conta de cobrança insuficiente para a taxa.
400	TED000XXX	Bad Request	Transaction amount is over limit.	O total da transferência é superior ao limite.
400	TED000XXX	Bad Request	Insufficient account balance for transfer and fee amount.	Saldo de conta insuficiente para a transferência e a taxa
400	TED000XXX	Bad Request	request_control_key {request_control_key} already in use	request_control_key {request_control_key} já utilizada
400	TED000XXX	Invalid Target Account Number	Target account number is invalid	Número da conta de destino é inexistente ou inválido
400	TED000XXX	Invalid Target Account Document Number	Target account document is invalid	Número de documento enviado é inválido
400	TED000XXX	Unrelated Beneficiary Document Number	Target account document is not the same as sent	Número de documento da conta de destino diferente do enviado
400	TED000XXX	Blocked Target Account	Target account is blocked.	A conta de destino encontra-se bloqueada.
400	TED000XXX	Closed Target Account	Target account is closed.	A conta de destino encontra-se encerrada.
400	TED000XXX	Rejected Payment Order	Transaction refused by target	Transação rejeitada por recebedor.

Consultar Transação TED

Request

ENDPOINT

/account/ACCOUNT_KEY/ted/TED_KEY/TED_DIRECTION

MÉTODO

GET

Request Path Params

Campo	Tipo	Descrição	Caracteres
ted_direction *	string	Filtro para indicar se uma transação é de entrada ou saída.	Enumerador ted_direction
account_key *	uuidv4	Chave única de identificação da conta QI	36
ted_key *	uuidv4	Chave única de identificação da transferência TED	36

Enumeradores ted_direction

Enumerador	Tradução
incoming	entrada
outgoing	saída

Atenção

Será apenas permitida a visualização de uma transferência caso o requisitante tenha permissões na conta de saída da transação para o caso da ted_direction de outgoing ou tenha permissões na conta de entrada da transação para o caso da ted_direction de incoming. Caso o contrário um erro de não encontrado será retornado.

Response

STATUS

200

Response Body: Transferência Rejeitada (outgoing)

{
  "request_control_key": "6e290347-330d-4b3a-8ebb-2ac217ad6eb3",
  "ted_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
  "account_key": "fc6862c4-2b20-4057-8063-b8809866e494",
  "created_at": "2021-10-22T20:30:23.459Z",
  "ted_status": "rejected",
  "transaction_amount": 126.97,
  "fee_amount": 0.0,
  "target_account": {
    "account_branch": "0001",
    "account_digit": "6",
    "account_number": "78340",
    "ispb": "12345678",
    "owner_document_number": "32402502000135",
    "owner_name": "QI Tech"
  },
  "refusal_reason": {
    "refusal_code": 1,
    "enumerator": "conta_destinatario_encerrada",
    "description": "Conta Destinatária do Crédito Encerrada"
  }
}

Response Body: Transferência Enviada (outgoing)

{
  "request_control_key": "6e290347-330d-4b3a-8ebb-2ac217ad6eb3",
  "ted_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
  "account_key": "fc6862c4-2b20-4057-8063-b8809866e494",
  "created_at": "2021-10-22T20:30:23.459Z",
  "ted_status": "sent",
  "transaction_amount": 126.97,
  "fee_amount": 0.0,
  "target_account": {
    "account_branch": "0001",
    "account_digit": "6",
    "account_number": "78340",
    "ispb": "12345678",
    "owner_document_number": "32402502000135",
    "owner_name": "QI Tech"
  },
  "refusal_reason": {}
}

Response Body: Transferência Recebida (incoming)

{
  "request_control_key": "6e290347-330d-4b3a-8ebb-2ac217ad6eb3",
  "ted_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
  "account_key": "fc6862c4-2b20-4057-8063-b8809866e494",
  "created_at": "2021-10-22T20:30:23.459Z",
  "ted_status": "received",
  "transaction_amount": 126.97,
  "fee_amount": 0.0,
  "source_account": {
    "account_branch": "0001",
    "account_digit": "6",
    "account_number": "78340",
    "ispb": "12345678",
    "owner_document_number": "32402502000135",
    "owner_name": "QI Tech"
  },
  "refusal_reason": {}
}

STATUS

4xx

Response Body: Error

{
  "title": "titulo",
  "description": "description in English",
  "translation": "descrição em portugues",
  "code": "codigo",
  "extra_fields": {}
}

Código HTTP status	Código QI code	Título title	Descrição (eng) description	Descrição (ptbr) translation
404	TED000XXX	Outgoing TED Not Found	Ted key {ted_key} was not found	Transferência Ted de saída com chave {ted_key} não foi encontrada.
404	TED000XXX	Incoming TED Not Found	Ted key {ted_key} was not found	Transferência Ted de entrada com chave {ted_key} não foi encontrada.

Consultar Transações TED

Request

ENDPOINT

/account/ACCOUNT_KEY/teds

MÉTODO

GET

Path Params

Campo	Tipo	Descrição	Caracteres
account_key *	uuidv4	Chave única de identificação da conta QI	36

Query Params

Campo	Tipo	Descrição	Caracteres
ted_direction	enumerator	Indicador do sentido da transação (entrada ou saída). Caso não seja enviado, outgoing será considerado	Enumeradores ted_transfer_direction
request_control_key	uuidv4	Chave única de identificação da request utilizada pelo cliente.	36
date_from	string	Data inicial. Formato "YYYY-MM-DD"
date_to	string	Data final. Formato "YYYY-MM-DD"
page	integer	Número da página requisitada. 1 por padrão
page_size	integer	Tamanho da página requisitada na consulta. 30 por padrão e valor máximo	Valor máximo de 30

Enumeradores ted_transfer_direction

Enumerador	Descrição
incoming	Transferência TED de entrada
outgoing	Transferência TED de saída

Response

STATUS

201

Response Body

{
  "data": [
    {
      "request_control_key": "6e290347-330d-4b3a-8ebb-2ac217ad6eb3",
      "ted_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
      "account_key": "fc6862c4-2b20-4057-8063-b8809866e494",
      "created_at": "2021-10-22T20:30:23.459Z",
      "ted_status": "sent",
      "transaction_amount": 126.97,
      "fee_amount": 0.0,
      "target_account": {
        "account_branch": "0001",
        "account_digit": "6",
        "account_number": "78340",
        "ispb": "12345678",
        "owner_document_number": "32402502000135",
        "owner_name": "QI Tech"
      },
      "refusal_reason": {}
    }
  ],
  "pagination": {
    "current_page": 1,
    "rows_per_page": 30
  }
}

Webhook após finalização de envio de TED

Webhook informará caso uma transação TED tenha sido devolvida.

Webhook Request Body

Webhook Body: TED Rejeitada

{
  "webhook_type": "baas.ted.outgoing_ted",
  "webhook_datetime": "2021-10-22T20:30:23.459Z",
  "data": {
    "request_control_key": "6e290347-330d-4b3a-8ebb-2ac217ad6eb3",
    "ted_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
    "account_key": "fc6862c4-2b20-4057-8063-b8809866e494",
    "created_at": "2021-10-22T20:30:23.459Z",
    "ted_status": "sent",
    "transaction_amount": 126.97,
    "fee_amount": 0.0,
    "target_account": {
      "account_branch": "0001",
      "account_digit": "6",
      "account_number": "78340",
      "ispb": "12345678",
      "owner_document_number": "32402502000135",
      "owner_name": "QI Tech"
    },
    "refusal_reason": {
      "refusal_code": 1,
      "enumerator": "conta_destinatario_encerrada",
      "description": "Conta Destinatária do Crédito Encerrada"
    }
  }
}

Webhook Body Param

Campo	Tipo	Descrição	Max. Caracteres
webhook_type	string	Um enumerador que define o tipo de evento sendo reportado	23
webhook_datetime	string	Data e hora do envio do webhook	20
request_control_key	string	Chave única de identificação da request utilizada pelo cliente no formato uuid v4	36
ted_key	string	Chave única de identificação da transferência TED	36
created_at	string	Data e hora de criação da transação	24
ted_status	string	Status da transação TED	Enumerador ted_status
transaction_amount	number	Valor da transferência	10
fee_amount	number	Valor da taxca cobrada pela transferencia	35
target_account	Object	Conta destino - Só deve ser enviada em transações do tipo "manual"	Objeto target_account
refusal_reason	Object	Motivo da recusa de acordo com o padrão do Banco Central	Objeto refusal_reason

Enumerador ted_status

Enumerador	Descrição
sent	Transferência TED realizada com sucesso.
pending	Transferência TED pendente.
rejected	Transferência TED rejeitada.
returned	Transferência TED devolvida.

Objeto target_account

Campo	Tipo	Descrição	Caracteres
account_branch *	string	Agência.	4
account_digit *	string	Dígito da conta	1
account_number *	string	Número da conta.	20
owner_document_number *	string	CPF ou CNPJ (apenas números) do titular da conta.	14
owner_name *	string	Nome do titular da conta.	50
account_type*	string	Tipo da conta.	Enumerador account_type
ispb *	string	Base no CNPJ da instituição financeira (8 dígitos).	8

Objeto refusal_reason

Campo	Tipo	Descrição	Caracteres
bacen_code *	string	Código de recusa Bacen	3
enumerator *	string	Enumerador da recusa Bacen	100
description *	string	Descrição da recusa Bacen	100

Enumerador account_type

Enumerador	Tradução
checking_account	conta corrente
deposit_account	conta depósito
guaranteed_account	conta de garantia
investment_account	conta de investimento
payment_account	conta de pagamento
saving_account	conta poupança

Webhook após o recebimento de TED

Webhook informará sobre o status final da transação TED.

Webhook Request Body

Request Body: TED Recebida

{
  "webhook_type": "baas.ted.incoming_ted",
  "webhook_datetime": "2021-10-22T20:30:23.459Z",
  "data": {
    "request_control_key": "6e290347-330d-4b3a-8ebb-2ac217ad6eb3",
    "ted_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
    "account_key": "fc6862c4-2b20-4057-8063-b8809866e494",
    "created_at": "2021-10-22T20:30:23.459Z",
    "ted_status": "received",
    "transaction_amount": 126.97,
    "fee_amount": 0.0,
    "source_account": {
      "account_branch": "0001",
      "account_digit": "6",
      "account_number": "78340",
      "ispb": "12345678",
      "owner_document_number": "32402502000135",
      "owner_name": "QI Tech"
    },
    "refusal_reason": {}
  }
}

Webhook Body Param

Campo	Tipo	Descrição	Max. Caracteres
webhook_type	string	Um enumerador que define o tipo de evento sendo reportado	23
webhook_datetime	string	Data e hora do envio do webhook	20
ted_key	string	Chave única de identificação da transferência TED	36
created_at	string	Data e hora de criação da transação	100
ted_status	string	Status da transação TED	Enumerador ted_status
transaction_amount	number	Valor da transferência	10
fee_amount	number	Valor da taxca cobrada pela transferencia	35
target_account	Object	Conta destino - Só deve ser enviada em transações do tipo "manual"	Objeto target_account
refusal_reason	Object	Motivo da recusa de acordo com o padrão do Banco Central	Objeto refusal_reason

Enumerador ted_status

Enumerador	Descrição
received	Transferência TED realizada com sucesso.
pending	Transferência TED pendente.
rejected	Transferência TED rejeitada.

Objeto target_account

Campo	Tipo	Descrição	Caracteres
account_branch *	string	Agência.	10
account_digit *	string	Dígito da conta	10
account_number *	string	Número da conta.	10
owner_document_number *	string	CPF ou CNPJ (apenas números) do titular da conta.	14
owner_name *	string	Nome do titular da conta.	50
account_type*	string	Tipo da conta.	Enumerador account_type
ispb *	string	Base no CNPJ da instituição financeira (8 dígitos).	8

Objeto refusal_reason

Campo	Tipo	Descrição	Caracteres
bacen_code *	string	Código de recusa Bacen	3
enumerator *	string	Enumerador da recusa Bacen	100
description *	string	Descrição da recusa Bacen	100

Enumerador account_type

Enumerador	Tradução
checking_account	conta corrente
deposit_account	conta depósito
guaranteed_account	conta de garantia
investment_account	conta de investimento
payment_account	conta de pagamento
saving_account	conta poupança