Pular para o conteúdo principal

Solicitar Transação com Autenticação de Dois Fatores

Request​

ENDPOINT
/account/ACCOUNT_KEY/pix_transfer
MÉTODO
POST

Path Params​

CampoTipoDescriçãoCaracteres
account_keyuuidv4Chave única de identificação da conta.36

Autenticação via Email e SMS​

Request Body: Transferência via Chave Pix com TFA por SMS ou Email
{
  "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"
  }
}

Autenticação via Dispositivo​

Além das formas já existentes de autenticação via sms e email, é possível autenticar a transação utilizando um dispositivo previamente cadastrado. Nesse caso, o session_id deve ser obtido na Device Scan e enviado no tfa_info.

Request Body: Transferência via Chave Pix com TFA por Dispositivo
{
  "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​

CampoTipoDescriçãoCaracteres
request_control_key *uuidv4Chave única de identificação da request utilizada pelo cliente no formato uuid v4.36
pix_transfer_type *enumeratorTipo do pix a ser realizado. Para o caso de transferência por chave deve ser key.key
target_pix_key *stringChave pix da conta a ser enviada a transação.100
transaction_amount *numberValor da transferência.10
end_to_end_id *stringChave de idempotência de uma transação Pix dentro do SPI (Sistema de Pagamento Instantâneo). Esta chave é retornada na consulta de chave Pix. Só deve ser enviado se o pix_transfer_type for key, static_qr_code ou static_qr_code32
pix_messagestringMensagem a ser enviada junto à transferência Pix.140
tfa_info*ObjectObjeto contendo o documento da pessoa aprovadora da conta e a forma de contato.Objeto tfa_info

Objeto tfa_info​

CampoTipoDescriçãoCaracteres
approver_document_number*stringNúmero de documento da pessoa aprovadora da conta.11
session_idstringChave única de identificação da sessão do dispositivo no formato UUID v4 (obrigatório para TFA via dispositivo).36
contact_type*stringForma de contato com a pessoa aprovadora da conta, podendo ser sms, email ou device
Aviso

O end_to_end_id da consulta deve ter sido feito em nome da conta que solicitará a movimentação!

Aviso

Um end_to_end_id só pode ser utilizado para uma única transferência, não importando, se a transferência tenha sido bem sucedida ou não.

Response​

STATUS
202
Response Body: Transação Solicitada
{
  "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: Transferência Rejeitada
{
  "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": {}
}
Código HTTP
status		Código QI
code		Título
title		Descrição (eng)
description		Descrição (ptbr)
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.
400PXT000003Account is ClosedAccount {account_key} is closed.Conta {account_key} está fechada.
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
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
400PXT000115Bad RequestInsufficient account balance for transfer and fee amount.Saldo de conta insuficiente para a transferência e a taxa
400PXT000128Bad RequestPix key {pix_key} sent does match inquiry pix key. Verify if end_to_end_id sent is correctChave Pix {pix_key} enviada não condiz com consulta. Verifique se end_to_end_id enviado está correto
400PXT000109Bad Requestrequest_control_key {request_control_key} already in userequest_control_key {request_control_key} já utilizada
400PXT000061Bad RequestEnd to end id invalid. A pix transfer with the end to end id {end_to_end} has already been registered!End to end id inválido. Uma transação pix com o identificador único {end_to_end} já foi registrada!
400PXT000129SPI Error messageMessage rejected by SPI-ICOMMensagem rejeitada pela SPI-ICOM
408PXT000130SPI Timeout ControlSPI Timeout ControlControle de timeout no SPI
400PXT000131Receiver Internal ErrorCancelled transaction due to receiver's internal errorTransação interrompida devido a erro no PSP do Recebedor
400PXT000132Invalid Target Account NumberTarget account number is invalidNúmero da conta de destino é inexistente ou inválido
400PXT000133Blocked Target AccountTarget account is blocked.A conta de destino encontra-se bloqueada.
400PXT000134Closed Target AccountTarget account is closed.A conta de destino encontra-se encerrada.
400PXT000135Unsupported TransactionUnsupported transaction for given target account.A conta de destino não suporta este tipo de transação.
400PXT000136Invalid ParticipantSPI participant is not PSP settler agent of payer nor receiver.Participante direto do SPI não é liquidante do PSP do Pagador / Recebedor.
400PXT000137Zero Value Payment OrderZero value payment order.Ordem de pagamento com valor zero.
400PXT000138Insufficient FundsInsufficient funds in PI account from payer.Saldo insuficiente na conta PI do pagador.
400PXT000139Return Value Too GreatReturn value greater than corresponding payment order.Valor de devolução acima do valor de pagamento correspondente.
400PXT000140Invalid Transactions NumberInvalid transactions number.Quantidade de transações inválida.
400PXT000141Unrelated Beneficiary Document NumberBeneficiary document number is not that of target account owner.CPF/CNPJ do usuário recebedor não é compatível com o titular da conta de destino.
400PXT000142Invalid Beneficiary Document NumberInvalid beneficiary document numberCPF/CNPJ da conta de destino está incorreto.
400PXT000143Incorrect Message ElementIncorrect message element.Elemento da mensagem incorreto.
403PXT000144Rejected Payment OrderBeneficiary's PSP has rejected payment order.Ordem de pagamento foi rejeitada pelo banco recebedor.
403PXT000145Unauthorized PayerSigning participant is unauthorized to make a payment order for paying account.Participante que assinou a mensagem não é autorizado a realizar a operação na conta PI debitada.
400PXT000146Invalid DatetimeInvalid datetime for message delivery.Data e Hora do envio da mensagem inválida.
400PXT000147Generic ErrorError while processing payment (generic error).Erro no processamento do pagamento (erro genérico).
400PXT000148Bad Format Operation IdentifierBadly formatted operation's identifier.Identificador da operação mal formatado.
400PXT000149Invalid Payer ISPBInvalid or non-existent payer's PSP ISPB number.Número ISPB do PSP do Pagador é inválido ou inexistente.
400PXT000150Invalid Beneficiary ISPBInvalid or non-existent beneficiary's PSP ISPB number.Número ISPB do banco recebedor é inválido ou inexistente.
400PXT000151Incorrect TypeIncorrect type for target account.Tipo incorreto para a conta transacional especificada.
400PXT000152Repeated End-to-End ID ErrorThe end_to_end_id was already usedO end_to_end_id já foi utilizado
400PXT000153Invalid Target Account TypeThe target account type cannot receive PIX transactionsO tipo de conta destino não pode receber transações PIX
400PXT000154Invalid ISPBInvalid or non-existent ISPB number.Número ISPB é inválido ou inexistente.
400PXT000155Amount too GreatAmount too great for credited account.Valor de pagamento/devolução acima do permitido para a conta de destino creditada.
400PXT000156QR Code RejectedQR Code rejected by beneficiary's PSP.QR Code rejeitado pelo PSP do usuário recebedor.
503PXT000157Bacen Service Unavailable ErrorCould not send the message to ICOM after 3 retriesNão pode enviar a mensagem para a ICOM depois de 3 tentativas
400PXT000158Invalid AmountPaid amount diverges from expected amount of {expected_amount}O valor do pagamento diverge do valor esperado de {expected_amount}
400PXT000159QR code inactiveQR code is not active at the time of paymentQR code não está ativo no instante do pagamento
400PXT000188Session ID neededA session_id must be provided tokenUma session_id deve ser fornecida