请求双因素身份验证 TED 调度

请求

ENDPOINT

/account/ACCOUNT_KEY/ted_schedule

方法

POST

通过邮件和短信进行身份验证

Request Body: 通过短信或邮件进行 TFA 的调度

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

通过设备进行身份验证

除了现有的 sms 和 email 身份验证方式外，还可以使用预先注册的设备对交易进行身份验证。在这种情况下，需要从 Device Scan 中获取 session_id 并在 tfa_info 中发送。

Request Body: 通过设备进行 TFA 的调度

{
  "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",
    "session_id": "b2f18d3a-67c2-4a7f-98e5-1d3f5c6b8a72",
    "contact_type": "device"
  }
}

Body Params

字段	类型	描述	字符数
`request_control_key` *	string	客户使用的 uuid v4 格式的请求唯一标识键。	36
`target_account` *	object	目标账户	Objeto target_account
`transaction_amount` *	float	转账金额	10
`schedule_date` *	string	执行交易的日期。	10
`tfa_info` *	Object	包含账户批准人文件号和联系方式的对象。	Objeto tfa_info

Objeto tfa_info

字段	类型	描述	字符数
`approver_document_number` *	string	账户批准人的文件号。	11
`session_id`	string	设备会话唯一标识键，UUID v4 格式（设备 TFA 必填）。	36
`contact_type` *	string	与账户批准人的联系方式，可为 sms、email 或 device

Objeto target_account

字段	类型	描述	字符数
`account_branch` *	string	银行代码（机构代码）。	4
`account_digit` *	string	账户校验码	1
`account_number` *	string	账户号码。	20
`owner_document_number` *	string	账户持有人的 CPF 或 CNPJ（仅数字）。	14
`owner_name` *	string	账户持有人姓名。	50
`account_type` *	string	账户类型。	Enumerador account_type
`ispb` *	string	基于金融机构 CNPJ（8 位数字）。	8

Enumerador account_type

枚举值	翻译
checking_account	活期账户
deposit_account	存款账户
guaranteed_account	担保账户
investment_account	投资账户
payment_account	付款账户
saving_account	储蓄账户

响应

STATUS

202

Response Body: 已创建调度

{
  "request_control_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
  "schedule_key": "f64b3fa7-d09d-4927-ad4f-b966df9fb153",
  "schedule_status": "pending_2fa_approval",
  "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": {}
}

HTTP 状态码 `status`	QI 代码 `code`	标题 `title`	描述（英文） `description`	描述（葡文） `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
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

请求​

通过邮件和短信进行身份验证​

通过设备进行身份验证​

Body Params​

Objeto tfa_info​

Objeto target_account​

Enumerador account_type​

响应​

请求