Pular para o conteúdo principal

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

Request​

ENDPOINT
/account/ACCOUNT_KEY/pix_schedule
MÉTODO
POST

Path Params​

CampoTipoDescriçãoCaracteres
account_keyuuidv4Chave única de identificação da conta.36
Request Body: Agendamento por Chave 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"
  }
}

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
schedule_date*stringData a ser realizada a transação.10
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
contact_type*stringForma de contato com a pessoa aprovadora da conta.Enumerador contact_type
EnumeradorDescrição
smsEnvio por Mensagem de Texto para telefone celular
emailEnvio por correio eletrônico
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
201
Response Body: Agendamento Criado
{
  "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": {}
}
Código HTTP
status		Código QI
code		Título
title		Descrição (eng)
description		Descrição (ptbr)
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