跳到主要内容

请求双因素认证交易

Request​

ENDPOINT
/account/ACCOUNT_KEY/pix_transfer
MÉTODO
POST

Path Params​

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

通过邮件和短信认证​

Request Body: 通过 Pix 密钥转账（短信或邮件 TFA）
{
  "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",
  "tfa_info": {
    "approver_document_number": "98765432100",
    "contact_type": "email"
  }
}

通过设备认证​

除了现有的短信和邮件认证方式外，还可以使用预先注册的设备对交易进行认证。此时，session_id 需从 Device Scan 获取并在 tfa_info 中发送。

Request Body: 通过 Pix 密钥转账（设备 TFA）
{
  "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",
  "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
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
202
Response Body: 交易已申请
{
  "request_control_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
  "pix_transfer_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
  "end_to_end_id": "E32402502202405081755SxyT2DDcVwc",
  "pix_transfer_status": "pending_2fa_approval",
  "created_at": "2021-10-22T20:30:23.459Z"
}
STATUS
4xx
Response Body: 转账已拒绝
{
  "title": "titulo",
  "description": "description in English",
  "translation": "descrição em portugues",
  "code": "codigo",
  "extra_fields": {
    "pix_transfer_data": {
      "request_control_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
      "pix_transfer_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
      "end_to_end_id": "E32402502202405081755SxyT2DDcVwc",
      "pix_transfer_status": "rejected",
      "created_at": "2021-10-22T20:30:23.459Z"
    }
  }
}
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 ErrorErro de Schema
400PXT000168No 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
400PXT000169tfa_info is requiredClient must send object tfa_infoCliente deve enviar objeto tfa_info
400PXT000170Error occurred while sending tokenAn unexpected error occurred while sending tokenUm erro inexperado ocorreu ao tentar enviar token
406PXT000103request_control_key must be a valid uuid v4 stringrequest_control_key was not accepted for not being a valid uuid v4 stringrequest_control_key não foi aceito por não ser uma palavra uuid v4 válida
400PXT000048Bad RequestEmoji not allowed in pix message.Emoji não é permitido na mensagem pix.
400PXT000104Invalid 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
404PXT000004Account not foundAccount not found for: {account_datum}Conta não encontrada para: {account_datum}
400PXT000003Account is ClosedAccount {account_key} is closed.Conta {account_key} está fechada.
422PXT000092Invalid 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
403PIT000001User is not allowed to do this transactionUsuário não tem autorização para fazer essa transação
400PXT000010Account is BlockedAccount {account_key} is blocked.Conta {account_key} está bloqueada.
400PIT000003Bad RequestInsufficient account balance for transfer and fee amount.Saldo de conta insuficiente para a transferência e a taxa.
400PXT000118Requester is not Pix ParticipantThe requester sent an alias key but is not a indirect pix participantO requisitante enviou uma alias key no entanto não é um participante do pix indireto
404PXT000120Alias sent not foundAlias key attached to this account not foundAlias key vinculada à conta não encontrada
406PXT000105Invalid end_to_end_idThe end_to_end_id sent {end_to_end_id} is not valid.O end_to_end_id enviado {end_to_end_id} não é válido.
400PXT000108Bad RequestBilling account closed or blockedConta de cobrança encerrada ou bloqueada
400PXT000079Bad RequestInsufficient billing account balance for fee.Saldo de conta de cobrança insuficiente para a taxa.
400PIT000004Bad RequestTransaction amount is over limit.O total da transferência é superior ao limite.
404PIX000056Not FoundPix key inquiry not foundConsulta de chave pix não encontrada
404PXT000041Not FoundQr Code not foundQr Code não encontrado
400PXT000053Bad RequestQrCode already paidQr Code já Pago
400PXT000188Session ID neededA session_id must be provided tokenUma session_id deve ser fornecida