Solicitar Agendamento de Transação Ted

Request

ENDPOINT

/account/ACCOUNT_KEY/ted_schedule

MÉTODO

POST

Request Body

{
  "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"
}

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 *	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

201

Response Body: Agendamento Criado

{
  "request_control_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
  "schedule_key": "f64b3fa7-d09d-4927-ad4f-b966df9fb153",
  "schedule_status": "scheduled",
  "schedule_date": "2024-12-31"
}

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	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
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