Solicitar Agendamento de Transação Ted em Lote

A QI Tech oferece a possibilidade de realizar várias transações agendadas ted com uma única chamada. Caso na chamada inicial seja retornado um http status 4xx, nenhum dos agendamentos será realizado.

Neste tipo de agendamento, é necessário a confirmação da programação de pagamento via token enviado à pessoa com poderes de aprovação de movimentação na conta credora.

A solicitação de agendamento Ted em lote por parceiros integradores configurados para a utilização de autenticação de dois fatores é realizada de forma similar ao descrito em solicitar agendamento de_transação_ted_em_lote. A diferença ocorre na adição do objeto tfa_info, contento informações sobre o aprovador da transferência e a forma de contato, e o status de uma solicitação bem sucedida que será sempre pending_2fa_approval.

O evento de notificação para o envio de token ao aprovador é baas.token_validation.ted.schedule.batch. É possível personalizar a mensagem enviada.

Request

ENDPOINT

/account/ACCOUNT_KEY/ted_schedule_batch

MÉTODO

POST

{
  "request_control_key": "6e4fc980-f8a1-4462-b6e2-d8a49f0ac055",
  "ted_schedules": [
    {
      "request_control_key": "0c3d2a3e-c121-464e-b5a4-8e69e0c17bbd",
      "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,
      "schedule_date": "2024-12-01"
    }
  ],
  "tfa_info": {
    "approver_document_number": "98765432100",
    "contact_type": "email"
  }
}

Path Params

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

Body Params

Campo	Tipo	Descrição	Caracteres
request_control_key *	uuidv4	Chave única de identificação da request utilizada pelo cliente no formato uuid v4.	36
ted_schedules *	array	Lista de objetos ted_schedule vinculados ao lote.	lista de Objeto ted_schedule
tfa_info*	Object	Objeto contendo o documento da pessoa aprovadora da conta e a forma de contato.	Objeto tfa_info

Objeto tfa_info

Campo	Tipo	Descrição
approver_document_number*	string	Número de documento da pessoa aprovadora da conta.
contact_type*	string	Forma de contato com a pessoa aprovadora da conta, podendo ser sms ou email

Objeto ted_schedule

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
schedule_date*	string	Data a ser realizada a transação.	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

202

Response Body: Agendamento em lote Requisitado

{
  "request_control_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
  "schedule_batch_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
  "schedule_batch_status": "pending_2fa_approval",
  "created_at": "2021-10-22T20:30:23.459Z"
}

Enumerador schedule_batch_status

Enumerador	Descrição
created	Agendamento em lote criado
approved	Agendamento em lote aprovado
rejected	Agendamento em lote rejeitado
pending_2fa_approval	Agendamento em lote pendente de aprovação por autenticação de dois fatores

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 description	Schema Inválido
404	TED000006	Target account Not Found	Target account was not found for given parameters	Conta destino não encontrada para os parâmetros informados
404	TED000009	Not Found	Account not found for the given key: {account_key}	Conta não encontrada para a chave fornecida: {account_key}
403	TED000014	Invalid target account	Invalid target account	Conta destino inválida
400	TED000015	Bad Request	Account blocked or closed can not perform this action	A conta bloqueada ou fechada não pode executar esta ação
400	TED000016	Bad Request	Hub account can not perform this action	A conta hub não pode executar esta ação
403	TED000018	Unauthorized	Provided account not owned by SELECTED_AGENT	Conta fornecida não pertencente ao SELECTED_AGENT
400	TED000031	Bad Request	ISPB number {ispb} does not exist or is inactive	ISPB {ispb} não existe ou está inativo
400	TED000044	Invalid Timestamp Format sent	Given parameter is not in the correct format {timestamp_format}	Parametro enviado não está no formato correto {timestamp_format}
400	TED000045	Search Params Error	Invalid integer value for page or size querystring parameters	Valor inválido para parâmetros de página ou tamanho de página
400	TED000046	Invalid uuid v4 string sent	{key} was not accepted for not being a valid uuid v4 string	{key} não foi aceito por não ser uma palavra uuid v4 válida
400	TED000054	Invalid Transaction Amount	Transaction Amount {transaction_amount} is invalid	Valor de transação {transaction_amount} é inválido
400	TED000057	Invalid Document Number	Given {document_number} document number is invalid	CPF/CNPJ {document_number} fornecido não é valido
409	TED000064	Bad Request	request_control_key {request_control_key} already in use	request_control_key {request_control_key} já utilizada
400	TED000065	Bad Request	It has been identified by request_control_key that this request is already being processed	Foi identificado por request_control_key que está requisição está sendo processada
403	TED000079	No approver permission	Given document number does not belong to an approver for this account	Número de documento enviado não pertence a um aprovador da conta
400	TED000080	tfa_info is required	Client must send object tfa_info	Cliente deve enviar objeto tfa_info
400	TED000081	Error occurred while sending token	An unexpected error occurred while sending token	Um erro inexperado ocorreu ao tentar enviar token
400	TED000089	Invalid Schedule Date	Schedule date must be after current date for UTC-3	Data de agendamento deve ser após a data atual em UTC-3
400	TED000090	Invalid Schedule Date	Schedule date must be a workday	Data de agendamento deve ser um dia útil
400	TED000091	Target Account and Source Account must be different	Target Account must not be the same as Source Account	A conta de destino não pode ser a mesma da conta de origem