跳到主要内容

申请双因素认证的 Pix 交易预约

Request​

ENDPOINT
/account/ACCOUNT_KEY/pix_schedule
MÉTODO
POST

Path Params​

字段类型描述字符数
account_keyuuidv4账户的唯一标识键。36

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

Request Body: 通过短信或邮件进行 TFA 的 Pix 密钥预约
{
  "request_control_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
  "pix_transfer_type": "key",
  "target_pix_key": "target_pix_key@email.com",
  "transaction_amount": 500.65,
  "end_to_end_id": "E73856642202309201429bZKfklNlbwu",
  "pix_message": "Ola Mundo",
  "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 的 Pix 密钥预约
{
  "request_control_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
  "pix_transfer_type": "key",
  "target_pix_key": "target_pix_key@email.com",
  "transaction_amount": 500.65,
  "end_to_end_id": "E73856642202309201429bZKfklNlbwu",
  "pix_message": "Ola Mundo",
  "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 *uuidv4客户使用的请求唯一标识键，uuid v4 格式。36
pix_transfer_type *enumerator要执行的 Pix 类型。密钥转账时应为 key。key
target_pix_key *string目标账户的 Pix 密钥。100
transaction_amount *number转账金额。10
end_to_end_id *stringSPI（即时支付系统）内 Pix 交易的幂等键。此键在 Pix 密钥查询中返回。仅当 pix_transfer_type 为 key、static_qr_code 或 static_qr_code 时发送32
pix_messagestring随 Pix 转账发送的消息。140
schedule_date*string执行交易的日期。10
tfa_info*Object包含账户审批人文件及联系方式的对象。Objeto tfa_info

Objeto tfa_info​

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

查询的 end_to_end_id 必须以发起转账的账户名义完成！

注意

一个 end_to_end_id 只能用于一笔转账，无论转账是否成功。

Response​

STATUS
201
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",
  "created_at": "2023-03-13T19:00:28.440Z"
}
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
400QIT000001Bad Requestschema error descriptionSchema Inválido
404PSC000001Account not FoundAccount was not foundConta não encontrada
406PSC000002Invalid Uuidkey was not accepted for not being a valid uuid v4 stringkey não foi aceito por não ser uma palavra uuid v4 válida
400PSC000003Bad Requestpix_message can not be longer than 140 characterspix_message não pode ser maior que 140 caracteres
400PSC000004Bad RequestEmoji not allowed in pix messageEmoji não é permitido na mensagem pix
406PSC000005Invalid Transaction AmountTransaction amount of transaction_amount is not valid. It must be a positive value with at maximum 2 decimal placesO valor de transação transaction_amount não é válido. Deve ser um valor positivo com no máximo duas casas decimais
406PSC000006Invalid end_to_end_idThe end_to_end_id sent end_to_end_id is not validO end_to_end_id enviado end_to_end_id não é válido
400PSC000007Invalid date formatDates must be sent using format YYYY-MM-DDDatas devem ser enviadas no formato YYYY-MM-DD
400PSC000008Invalid Schedule DateSchedule date must be after current date for UTC-3Data de agendamento deve ser após a data atual em UTC-3
400PSC000009Account is ClosedAccount is closedConta está fechada
400PSC000010Account is BlockedAccount is blockedConta está bloqueada
422PSC000011Invalid Account TypePix is not yet implemented for non-checking or non-escrow account typesTransações Pix não estão implementadas para conta que não sejam escrow ou livres
403PSC000012User is not allowed to do this transactionUser is not allowed to do this transactionUsuário não tem autorização para fazer essa transação
400PSC000013Bad RequestFor Manual Pix Transfer Type a target account must be providedPara transação pix do tipo manual, uma conta destino deve ser fornecida
404PSC000014Inquiry Not FoundPix key inquiry was not foundPesquisa de chave pix não encontrada
400PSC000015Bad RequestPix key sent does match inquiry pix key. Verify if end_to_end_id sent is correctChave Pix enviada não condiz com consulta. Verifique se end_to_end_id enviado está correto
404PSC000016Account not foundNonexistent account in destination financial institutionConta inexistente na instituição financeira de destino
400PSC000017Target Account and Source Account must be differentTarget Account must not be the same as Source AccountA conta de destino não pode ser a mesma da conta de origem
409PSC000018Bad Requestrequest_control_key request_control_key already in userequest_control_key request_control_key já utilizada
400PSC000019Invalid TargetAccount does not have permission to transfer to the given target accountA conta não possui permissão para realizar transferências para a conta enviada
404PSC000020Decode Inquiry Not FoundQR Code decode inquiry not foundPesquisa e decodificação de QR code não encontrada
400PSC000021Bad RequestReceiver Conciliation Id sent does match decode inquiry receiver_conciliation_id. Verify if end_to_end_id sent is correctIdentificador de transação enviado não condiz com consulta. Verifique se end_to_end_id enviado está correto
400PSC000022Bad RequestDynamic Instant QR codes cannot be scheduled for paymentPagamentos de vencimento instantâneo não podem ter pagamento agendado
400PSC000023Bad RequestSchedule Date sent is after max payment date for target qr codeData de agendamento enviada é após a data máxima de pagamento para o qr code enviado
400PSC000024Bad RequestPix transfer type sent does match decode inquiry qr code type. Verify if end_to_end_id sent is correctTipo de transação pix enviado enviado não condiz com tipo de qr code da consulta. Verifique se end_to_end_id enviado está correto
400PSC000046tfa_info is requiredClient must send object tfa_infoCliente deve enviar objeto tfa_info
403PSC000047No approver permissionGiven document number does not belong to an approver for this accountNúmero de documento enviado não pertence a um aprovador da conta
400PSC000048Error occurred while sending tokenAn unexpected error occurred while sending tokenUm erro inesperado ocorreu ao tentar enviar token