Pix

Realização de Transação Pix

Request

ENDPOINT

/account/ACCOUNT_KEY/pix_transfer

MÉTODO

POST

Path Params

Campo	Tipo	Descrição	Caracteres
account_key	uuidv4	Chave única de identificação da conta.	36

Chave

Request Body: Transferência 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"
}

Body Params

Campo	Tipo	Descrição	Caracteres
request_control_key *	uuidv4	Chave única de identificação da request utilizada pelo cliente no formato uuid v4.	36
pix_transfer_type *	enumerator	Tipo do pix a ser realizado. Para o caso de transferência por chave deve ser key.	"key"
target_pix_key *	string	Chave pix da conta a ser enviada a transação.	100
transaction_amount *	number	Valor da transferência.	10
end_to_end_id *	string	Chave 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 dynamic_qr_code	32
pix_message	string	Mensagem a ser enviada junto à transferência Pix.	140

Manual

Request Body: Transferência Manual

{
  "request_control_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
  "pix_transfer_type": "manual",
  "target_account": {
    "account_branch": "0001",
    "account_digit": "3",
    "account_number": "12345678",
    "owner_document_number": "32402502000135",
    "owner_name": "Qi Tech",
    "account_type": "checking_account",
    "ispb": "32402502"
  },
  "transaction_amount": 500.65,
  "pix_message": "Ola Mundo"
}

Body Params

Campo	Tipo	Descrição	Caracteres
request_control_key *	uuidv4	Chave única de identificação da request utilizada pelo cliente no formato uuid v4.	36
pix_transfer_type *	enumerator	Tipo de transferência Pix.	manual
target_account *	Object	Conta destino - Só deve ser enviada em transferências com pix_transfer_type do tipo manual.	Objeto target_account
transaction_amount *	number	Valor da transferência.	10
pix_message	string	Mensagem a ser enviada junto à transferência Pix.	140

Objeto target_account

Campo	Tipo	Descrição	Caracteres
account_branch *	string	Agência da conta.	6
account_digit *	string	Dígito da conta.	1
account_number *	string	Número da conta.	20
owner_document_number *	string	CPF ou CNPJ (apenas números) do titular da conta.	14
owner_name *	string	Nome do titular da conta.	150
account_type*	enumerator	Tipo da conta.	Enumerador account_type
ispb *	string	Base no CNPJ da instituição financeira (8 dígitos).	8

Enumerador account_type

Enumerador	Descrição
checking_account	Conta Corrente
salary_account	Conta Salário
saving_account	Conta Poupança
payment_account	Conta de Pagamentos

Qr Code

Request Body: Transferência por Qr Code

{
  "request_control_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
  "pix_transfer_type": "static_qr_code",
  "transaction_amount": 500.65,
  "end_to_end_id": "E73856642202309201429bZKfklNlbwu",
  "receiver_conciliation_id": "REC00000000000000000000009459463343",
  "target_pix_key": "target_pix_key@email.com",
  "pix_message": "Ola Mundo"
}

Body Params

Campo	Tipo	Descrição	Caracteres
request_control_key *	uuidv4	Chave única de identificação da request utilizada pelo cliente no formato uuid v4.	36
pix_transfer_type *	enumerator	Tipo de transferência Pix.	static_qr_code ou dynamic_qr_code
target_pix_key *	string	Chave pix da conta a ser enviada a transação.	100
receiver_conciliation_id	string	Identicação de conciliação do recebedor.	35
transaction_amount *	number	Valor da transferência.	10
end_to_end_id *	string	Chave 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_code.	32
pix_message	string	Mensagem a ser enviada junto à transferência Pix.	140

Aviso

O end_to_end_id é retornado ao decodificar o QR Code Pix, utilizando a URI do Pix Copia e Cola.

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: Transferência Enviada

{
  "request_control_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
  "pix_transfer_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
  "pix_transfer_status": "sent",
  "created_at": "2021-10-22T20:30:23.459Z"
}

STATUS

202

Response Body: Transferência Pendente

{
  "request_control_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
  "pix_transfer_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
  "pix_transfer_status": "pending",
  "created_at": "2021-10-22T20:30:23.459Z"
}

Informação

Caso seja retornado HTTP Status 202 com o campo pix_transfer_status com valor pending, a solicitação de Pix não deve ser retentada.

Esta transferência será reprocessada. É necessário verificar o status da transferência por meio da Consulta de Transferência Pix.

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",
      "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
400	QIT000001	Bad Request	Schema Error	Erro de Schema
406	PXT000103	request_control_key must be a valid uuid v4 string	request_control_key was not accepted for not being a valid uuid v4 string	request_control_key não foi aceito por não ser uma palavra uuid v4 válida
400	PXT000048	Bad Request	Emoji not allowed in pix message.	Emoji não é permitido na mensagem pix.
400	PXT000104	Invalid Transaction Amount	Transaction amount of {transaction_amount} is not valid. It must be a positive value with at maximum 2 decimal places	O valor de transação {transaction_amount} não é válido. Deve ser um valor positivo com no máximo duas casas decimais
404	PXT000004	Account not found	Account not found for: {account_datum}	Conta não encontrada para: {account_datum}
400	PXT000003	Account is Closed	Account {account_key} is closed.	Conta {account_key} está fechada.
422	PXT000092	Invalid Account Type	Pix is not yet implemented for non-checking or non-escrow account types	Transações Pix não estão implementadas para conta que não sejam escrow ou livres
403	PIT000001	User is not allowed to do this transaction		Usuário não tem autorização para fazer essa transação
400	PXT000010	Account is Blocked	Account {account_key} is blocked.	Conta {account_key} está bloqueada.
400	PXT000003	Account is Closed	Account {account_key} is closed.	Conta {account_key} está fechada.
400	PIT000003	Bad Request	Insufficient account balance for transfer and fee amount.	Saldo de conta insuficiente para a transferência e a taxa.
400	PXT000118	Requester is not Pix Participant	The requester sent an alias key but is not a indirect pix participant	O requisitante enviou uma alias key no entanto não é um participante do pix indireto
404	PXT000120	Alias sent not found	Alias key attached to this account not found	Alias key vinculada à conta não encontrada
406	PXT000105	Invalid end_to_end_id	The 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.
400	PXT000108	Bad Request	Billing account closed or blocked	Conta de cobrança encerrada ou bloqueada
400	PXT000079	Bad Request	Insufficient billing account balance for fee.	Saldo de conta de cobrança insuficiente para a taxa.
400	PIT000004	Bad Request	Transaction amount is over limit.	O total da transferência é superior ao limite.
404	PIX000056	Not Found	Pix key inquiry not found	Consulta de chave pix não encontrada
404	PXT000041	Not Found	Qr Code not found	Qr Code não encontrado
400	PXT000053	Bad Request	QrCode already paid	Qr Code já Pago
400	PXT000118	Requester is not Pix Participant	The requester sent an alias key but is not a indirect pix participant	O requisitante enviou uma alias key no entanto não é um participante do pix indireto
404	PXT000120	Alias sent not found	Alias key attached to this account not found	Alias key vinculada à conta não encontrada
400	PXT000115	Bad Request	Insufficient account balance for transfer and fee amount.	Saldo de conta insuficiente para a transferência e a taxa
400	PXT000128	Bad Request	Pix key {pix_key} sent does match inquiry pix key. Verify if end_to_end_id sent is correct	Chave Pix {pix_key} enviada não condiz com consulta. Verifique se end_to_end_id enviado está correto
409	PXT000109	Bad Request	request_control_key {request_control_key} already in use	request_control_key {request_control_key} já utilizada
400	PXT000061	Bad Request	End 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!
400	PXT000129	SPI Error message	Message rejected by SPI-ICOM	Mensagem rejeitada pela SPI-ICOM
408	PXT000130	SPI Timeout Control	SPI Timeout Control	Controle de timeout no SPI
400	PXT000131	Receiver Internal Error	Cancelled transaction due to receiver's internal error	Transação interrompida devido a erro no PSP do Recebedor
400	PXT000132	Invalid Target Account Number	Target account number is invalid	Número da conta de destino é inexistente ou inválido
400	PXT000133	Blocked Target Account	Target account is blocked.	A conta de destino encontra-se bloqueada.
400	PXT000134	Closed Target Account	Target account is closed.	A conta de destino encontra-se encerrada.
400	PXT000135	Unsupported Transaction	Unsupported transaction for given target account.	A conta de destino não suporta este tipo de transação.
400	PXT000136	Invalid Participant	SPI participant is not PSP settler agent of payer nor receiver.	Participante direto do SPI não é liquidante do PSP do Pagador / Recebedor.
400	PXT000137	Zero Value Payment Order	Zero value payment order.	Ordem de pagamento com valor zero.
400	PXT000138	Insufficient Funds	Insufficient funds in PI account from payer.	Saldo insuficiente na conta PI do pagador.
400	PXT000139	Return Value Too Great	Return value greater than corresponding payment order.	Valor de devolução acima do valor de pagamento correspondente.
400	PXT000140	Invalid Transactions Number	Invalid transactions number.	Quantidade de transações inválida.
400	PXT000141	Unrelated Beneficiary Document Number	Beneficiary 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.
400	PXT000142	Invalid Beneficiary Document Number	Invalid beneficiary document number	CPF/CNPJ da conta de destino está incorreto.
400	PXT000143	Incorrect Message Element	Incorrect message element.	Elemento da mensagem incorreto.
403	PXT000144	Rejected Payment Order	Beneficiary's PSP has rejected payment order.	Ordem de pagamento foi rejeitada pelo banco recebedor.
403	PXT000145	Unauthorized Payer	Signing 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.
400	PXT000146	Invalid Datetime	Invalid datetime for message delivery.	Data e Hora do envio da mensagem inválida.
400	PXT000147	Generic Error	Error while processing payment (generic error).	Erro no processamento do pagamento (erro genérico).
400	PXT000148	Bad Format Operation Identifier	Badly formatted operation's identifier.	Identificador da operação mal formatado.
400	PXT000149	Invalid Payer ISPB	Invalid or non-existent payer's PSP ISPB number.	Número ISPB do PSP do Pagador é inválido ou inexistente.
400	PXT000150	Invalid Beneficiary ISPB	Invalid or non-existent beneficiary's PSP ISPB number.	Número ISPB do banco recebedor é inválido ou inexistente.
400	PXT000151	Incorrect Type	Incorrect type for target account.	Tipo incorreto para a conta transacional especificada.
400	PXT000152	Repeated End-to-End ID Error	The end_to_end_id was already used	O end_to_end_id já foi utilizado
400	PXT000153	Invalid Target Account Type	The target account type cannot receive PIX transactions	O tipo de conta destino não pode receber transações PIX
400	PXT000154	Invalid ISPB	Invalid or non-existent ISPB number.	Número ISPB é inválido ou inexistente.
400	PXT000155	Amount too Great	Amount too great for credited account.	Valor de pagamento/devolução acima do permitido para a conta de destino creditada.
400	PXT000156	QR Code Rejected	QR Code rejected by beneficiary's PSP.	QR Code rejeitado pelo PSP do usuário recebedor.
503	PXT000157	Bacen Service Unavailable Error	Could not send the message to ICOM after 3 retries	Não pode enviar a mensagem para a ICOM depois de 3 tentativas
400	PXT000158	Invalid Amount	Paid amount diverges from expected amount of {expected_amount}	O valor do pagamento diverge do valor esperado de {expected_amount}
400	PXT000159	QR code inactive	QR code is not active at the time of payment	QR code não está ativo no instante do pagamento

Consulta de Chave Pix no Banco Central

Request

ENDPOINT

/pix_key/PIX_KEY?account_key=ACCOUNT_KEY

MÉTODO

GET

Path Params

Campo	Tipo	Descrição	Caracteres
pix_key *	string	Chave Pix que será consultada.	77

Tipos de Chave Pix

A pix_key pode ser um CPF, CNPJ, E-mail, Celular ou uma Chave Aleatória (UUID), seguindo as seguintes formatações:

CPF: Número inteiro com 11 dígitos.

CNPJ: Número inteiro com 14 dígitos.

E-mail: Texto contendo ao menos um “@”.

Celular: Texto contendo os seguintes valores: “+55” + “DDD do celular“ + “Número Inteiro do Celular com no mínimo 8 e no máximo 9 dígitos”. Ex: “+5511987654321“.

Chave Aleatória: UUID4.

Query Params

Campo	Tipo	Descrição	Caracteres
account_key *	uuidv4	Chave única de identificação da conta.	36

Utilização de tokens de consulta

Para que o token de consulta de chave pix seja cobrado da pessoa correta, é obrigatório que o account_key seja enviado.

Response

STATUS

200

Response Body: Chave Ativa

{
  "account_branch": "0001",
  "account_created_at": "2023-09-06T22:03:34.000Z",
  "account_digit": "8",
  "account_number": "2897775",
  "account_type": "checking",
  "bank_code": null,
  "end_to_end_id": "E73856642202309201429bZKfklNlbwu",
  "financial_institution": "BANCO INDIRETO PRUPRU",
  "ispb": "32402502",
  "owner_masked_document_number": "**.458.****/0001-**",
  "owner_name": "Empresa teste 01",
  "owner_person_type": "legal",
  "owner_trading_name": null,
  "pix_key": "0f723f66-b333-4187-be16-97fc37c86052"
}

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
404	PIX000017	Pix Key is Unregistered	Pix key {pix_key} is not currently used	A chave pix {pix_key} não está sendo utilizada
400	PIX000081	Rate Limit Exceeded	Rate Limit Exceeded	Limite de requisições excedido

Efetuar devolução de um Pix

A devolução de um Pix pode ser efetuada em até 90 dias a partir de seu recebimento.

Request

ENDPOINT

/account/ACCOUNT_KEY/pix_transfer/PIX_TRANSFER_KEY/reversal

MÉTODO

POST

Path Params

Campo	Tipo	Descrição	Caracteres
account_key *	uuidv4	Chave única de identificação da conta.	36
pix_transfer_key *	uuidv4	Chave única de identificação da transferência Pix no sistema QI.	36

Request Body

{
  "request_control_key": "303393bf-8f2e-4ff0-b326-ee7ad612e8ca",
  "reversal_amount": 147,
  "reversal_reason": "client_request",
  "reversal_message": "Mensagem Pix da Devolução"
}

Request Body

Campo	Tipo	Descrição	Caracteres
request_control_key *	uuidv4	Chave de unicidade da requisição.	36
reversal_amount *	number	Valor da devolução.	11
reversal_reason *	string	Motivo da devolução.	Enumerador reversal_reason
reversal_message	string	Mensagem da devolução.	140

Enumerador reversal_reason

Enumerador	Descrição
client_request	Caso tenha sido requerido pelo dono da conta.
reconciliation	Para reconciliação devido a erro operacional.

Response

STATUS

201

Response Body: Reversão Enviada

{
  "reversal_status": "sent",
  "transfer_amount": 147,
  "pix_transfer_key": "cdcf0d25-08a1-46e3-902a-6d7ca75e6c48",
  "end_to_end_id": "E32402502202407112211Id9JbxoaiTf",
  "request_control_key": "7c5a1425-73eb-420e-b4fb-0ce3386c7d0c",
  "created_at": "2021-10-22T20:30:23.459Z"
}

STATUS

202

Response Body: Reversão Pendente

{
  "reversal_status": "pending",
  "transfer_amount": 147,
  "pix_transfer_key": "cdcf0d25-08a1-46e3-902a-6d7ca75e6c48",
  "end_to_end_id": "E32402502202407112211Id9JbxoaiTf",
  "request_control_key": "7c5a1425-73eb-420e-b4fb-0ce3386c7d0c",
  "created_at": "2021-10-22T20:30:23.459Z"
}

Informação

Caso seja retornado HTTP Status 202 com o campo pix_transfer_status com valor pending, a solicitação de Pix não deve ser retentada.

Esta transferência será reprocessada. É necessário verificar o status da transferência por meio da Consulta de Transferência Pix.

Response Body

Campo	Tipo	Descrição	Caracteres
reversal_status	enumerator	Enumerador de status da transação de devolução.	Enumerador reversal_status
transfer_amount	number	Valor da transferência de devolução.	11
pix_transfer_key	uuidv4	Chave da transação pix executada na devolução.	36
end_to_end_id	string	Chave de idempotência de uma transação Pix dentro do SPI (Sistema de Pagamento Instantâneo)	32
request_control_key	uuidv4	Chave única de identificação da request utilizada pelo cliente.	36
created_at	string	Data e hora da devolução.	10

Enumerador reversal_status

Enumerador	Descrição
sent	Transferência Pix realizada com sucesso.
pending	Transferência Pix pendente.
rejected	Transferência Pix rejeitada.

STATUS

4xx

Response Body: Reversão 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",
      "pix_transfer_status": "rejected",
      "created_at": "2021-10-22T20:30:23.459Z"
    }
  }
}

Informação

Além dos erros anteriormente listados para transferências Pix, a devolução de um Pix também pode retornar os erros listados abaixo.

Código HTTP status	Código QI code	Título title	Descrição (eng) description	Descrição (ptbr) translation
400	QIT000001	Bad Request	Schema Error	Erro de Schema
404	PXT000018	Reversal Original Transfer not Found	Reversal original pix transfer not found.	Transferência original da devolução não foi encontrada.
400	PXT000017	Reversal Too Great	Reversal transfers sum amount surpasses that of original pix transfer.	A soma das transferências de devolução ultrapassam o valor da transferência pix original.
400	PXT000015	Reversal date expired	Reversal original transaction is older than 90 days	A data de criação da transação original é mais antiga que 90 dias
400	PXT0000127	Invalid Reversal Reason	Reversal reason {reversal_reason} is not valid	Razão de reversão {reversal_reason} não é válida

Consultar Transação Pix por pix_transfer_key

Request

ENDPOINT

/account/ACCOUNT_KEY/pix_transfer/PIX_TRANSFER_KEY/PIX_TRANSFER_DIRECTION

MÉTODO

GET

Path Params

Campo	Tipo	Descrição	Caracteres
pix_transfer_direction *	enumerator	Indicador do sentido da transação (entrada ou saída).	Enumeradores pix_transfer_direction
account_key *	uuidv4	Chave única de identificação da conta QI.	36
pix_transfer_key *	uuidv4	Chave única de identificação da transferência Pix.	36

Enumeradores pix_transfer_direction

Enumerador	Descrição
incoming	Transferência Pix realizada com sucesso.
outgoing	Transferência Pix realizada com sucesso.

Response

STATUS

201

Response Body: Transferência Enviada (outgoing)

{
  "request_control_key": "6e290347-330d-4b3a-8ebb-2ac217ad6eb3",
  "pix_message": "Bom dia",
  "pix_transfer_type": "manual",
  "account_key": "fc6862c4-2b20-4057-8063-b8809866e494",
  "updated_at": "2021-10-22T20:30:23.459Z",
  "created_at": "2021-10-22T20:30:23.459Z",
  "target_account": {
    "account_branch": "0001",
    "account_digit": "3",
    "account_number": "12345678",
    "owner_document_number": "***02502000***",
    "owner_person_type": "legal",
    "owner_name": "Qi Tech",
    "account_type": "checking_account",
    "ispb": "32402502",
    "pix_key": null
  },
  "receiver_conciliation_id": null,
  "pix_transfer_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
  "end_to_end_id": "E3240250220211022203051750897529",
  "pix_transfer_status": "sent",
  "transfer_amount": 126.97,
  "fee_amount": 0.0,
  "rejection_reason": null,
  "reversals": [
    {
      "end_to_end_id": "D35713491202309182058jlqdBkkHSWU",
      "transfer_amount": 0.01,
      "reversal_reason": "client_request",
      "pix_transfer_status": "received",
      "pix_transfer_key": "423866cd-0f3f-4cdd-904b-0d2e33273afd",
      "request_control_key": "7c5a1425-73eb-420e-b4fb-0ce3386c7d0a",
      "created_at": "2021-10-23T20:30.459Z"
    }
  ]
}

Response Body: Transferência Rejeitada (outgoing)

{
  "request_control_key": "6e290347-330d-4b3a-8ebb-2ac217ad6eb3",
  "pix_message": "Bom dia",
  "pix_transfer_type": "manual",
  "account_key": "fc6862c4-2b20-4057-8063-b8809866e494",
  "updated_at": "2021-10-22T20:30:23.459Z",
  "created_at": "2021-10-22T20:30:23.459Z",
  "target_account": {
    "account_branch": "0001",
    "account_digit": "3",
    "account_number": "12345678",
    "owner_document_number": "***02502000***",
    "owner_person_type": "legal",
    "owner_name": "Qi Tech",
    "account_type": "checking_account",
    "ispb": "32402502",
    "pix_key": null
  },
  "receiver_conciliation_id": null,
  "pix_transfer_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
  "end_to_end_id": "E3240250220211022203051750897529",
  "pix_transfer_status": "rejected",
  "transfer_amount": 126.97,
  "fee_amount": 0.0,
  "error_code": "PXT000132",
  "error_description": "Target account number is invalid.",
  "error_translation": "Número da conta de destino é inexistente ou inválido.",
  "reversals": []
}

Response Body: Devolução Enviada (outgoing)

{
  "request_control_key": "6e290347-330d-4b3a-8ebb-2ac217ad6eb3",
  "pix_message": "Bom dia",
  "pix_transfer_type": "reversal",
  "account_key": "fc6862c4-2b20-4057-8063-b8809866e494",
  "updated_at": "2021-10-22T20:30:23.459Z",
  "created_at": "2021-10-22T20:30:23.459Z",
  "target_account": {
    "account_branch": "0001",
    "account_digit": "3",
    "account_number": "12345678",
    "owner_document_number": "***02502000***",
    "owner_person_type": "legal",
    "owner_name": "Qi Tech",
    "account_type": "checking_account",
    "ispb": "32402502",
    "pix_key": null
  },
  "receiver_conciliation_id": null,
  "pix_transfer_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
  "end_to_end_id": "E3240250220211022203051750897529",
  "pix_transfer_status": "sent",
  "transfer_amount": 126.97,
  "fee_amount": 0.0,
  "rejection_reason": null,
  "reversals": [],
  "original_incoming_pix_transfer": "6e290347-330d-4b3a-8ebb-2ac217ad6eb3"
}

Response Body: Transferência Recebida (incoming)

{
  "request_control_key": "6e290347-330d-4b3a-8ebb-2ac217ad6eb3",
  "pix_transfer_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
  "account_key": "fc6862c4-2b20-4057-8063-b8809866e494",
  "end_to_end_id": "E18236120202308111235s14fddf2801",
  "pix_transfer_status": "received",
  "receiver_conciliation_id": "745c28c780bc4822bbade86dd875d10b",
  "transfer_amount": 126.97,
  "fee_amount": 0.0,
  "source_account": {
    "account_branch": "0001",
    "account_digit": "3",
    "account_number": "12345678",
    "owner_document_number": "***02502000***",
    "owner_person_type": "legal",
    "owner_name": "Qi Tech",
    "account_type": "checking_account",
    "ispb": "32402502"
  },
  "pix_transfer_type": "dynamic_qr_code",
  "reversals": []
}

Response Body: Devolução Recebida (incoming)

{
  "request_control_key": "6e290347-330d-4b3a-8ebb-2ac217ad6eb3",
  "pix_transfer_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
  "account_key": "fc6862c4-2b20-4057-8063-b8809866e494",
  "end_to_end_id": "E18236120202308111235s14fddf2801",
  "pix_transfer_status": "received",
  "receiver_conciliation_id": "745c28c780bc4822bbade86dd875d10b",
  "transfer_amount": 126.97,
  "fee_amount": 0.0,
  "source_account": {
    "account_branch": "0001",
    "account_digit": "3",
    "account_number": "12345678",
    "owner_document_number": "***02502000***",
    "owner_person_type": "legal",
    "owner_name": "Qi Tech",
    "account_type": "checking_account",
    "ispb": "32402502"
  },
  "pix_transfer_type": "reversal",
  "reversals": [],
  "original_outgoing_pix_transfer": "6e290347-330d-4b3a-8ebb-2ac217ad6eb3"
}

Response Body: Transferência Rejeitada (incoming)

{
  "request_control_key": "6e290347-330d-4b3a-8ebb-2ac217ad6eb3",
  "pix_transfer_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
  "account_key": "fc6862c4-2b20-4057-8063-b8809866e494",
  "end_to_end_id": "E18236120202308111235s14fddf2801",
  "pix_transfer_status": "rejected",
  "receiver_conciliation_id": "745c28c780bc4822bbade86dd875d10b",
  "transfer_amount": 126.97,
  "fee_amount": 0.0,
  "source_account": {
    "account_branch": "0001",
    "account_digit": "3",
    "account_number": "12345678",
    "owner_document_number": "***02502000***",
    "owner_person_type": "legal",
    "owner_name": "Qi Tech",
    "account_type": "checking_account",
    "ispb": "32402502"
  },
  "pix_transfer_type": "dynamic_qr_code",
  "reversals": []
}

STATUS

4xx

Response Body: Error

{
  "title": "titulo",
  "description": "description in English",
  "translation": "descrição em portugues",
  "code": "codigo",
  "extra_fields": {}
}

Código HTTP	Código QI code	Título title	Descrição (eng) Description	Descrição (ptbr) translation
400	PXT000075	Pix Transfer Key or End To End Not Provided	No pix transfer key or end to end id provided.	Não foram fornecidos uma pix transfer key ou end to end id.
404	PXT000023	Outgoing PIX Transfer Not Found	Pix transfer key {pix_transfer_key} was not found	Transferência PIX de saída com chave {pix_transfer_key} não foi encontrada.
403	PIT000001	User is not allowed to do this transaction	User is not allowed to do this transaction	Usuário não tem autorização para fazer essa transação

Consultar Transações Pix

Request

ENDPOINT

/account/ACCOUNT_KEY/pix_transfers

MÉTODO

GET

Path Params

Campo	Tipo	Descrição	Caracteres
account_key *	uuidv4	Chave única de identificação da conta QI	36

Query Params

Campo	Tipo	Descrição	Caracteres
pix_transfer_direction	enumerator	Indicador do sentido da transação (entrada ou saída). Caso não seja enviado, outgoing será considerado	Enumeradores pix_transfer_direction
request_control_key	uuidv4	Chave única de identificação da request utilizada pelo cliente.	36
end_to_end_id	string	Chave de idempotência de uma transação Pix	32
transaction_key	uuidv4	Chave de identificação da movimentação na conta	36
date_from	string	Data inicial. Formato "YYYY-MM-DD"
date_to	string	Data final. Formato "YYYY-MM-DD"
page	integer	Número da página requisitada. 1 por padrão
page_size	integer	Tamanho da página requisitada na consulta. 30 por padrão e valor máximo	Valor máximo de 30

Enumeradores pix_transfer_direction

Enumerador	Descrição
incoming	Transferência Pix de entrada
outgoing	Transferência Pix de saída

Response

STATUS

201

Response Body

{
  "data": [
    {
      "request_control_key": "6e290347-330d-4b3a-8ebb-2ac217ad6eb3",
      "pix_message": "Bom dia",
      "pix_transfer_type": "manual",
      "account_key": "fc6862c4-2b20-4057-8063-b8809866e494",
      "updated_at": "2021-10-22T20:30:23.459Z",
      "created_at": "2021-10-22T20:30:23.459Z",
      "target_account": {
        "account_branch": "0001",
        "account_digit": "3",
        "account_number": "12345678",
        "owner_document_number": "***02502000***",
        "owner_person_type": "legal",
        "owner_name": "Qi Tech",
        "account_type": "checking_account",
        "ispb": "32402502",
        "pix_key": null
      },
      "receiver_conciliation_id": null,
      "pix_transfer_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
      "end_to_end_id": "E3240250220211022203051750897529",
      "pix_transfer_status": "sent",
      "transfer_amount": 126.97,
      "fee_amount": 0.0,
      "rejection_reason": null,
      "reversals": [
        {
          "end_to_end_id": "D35713491202309182058jlqdBkkHSWU",
          "transfer_amount": 0.01,
          "reversal_reason": "client_request",
          "pix_transfer_status": "received",
          "pix_transfer_key": "423866cd-0f3f-4cdd-904b-0d2e33273afd",
          "request_control_key": "7c5a1425-73eb-420e-b4fb-0ce3386c7d0a",
          "created_at": "2021-10-23T20:30.459Z"
        }
      ]
    }
  ],
  "pagination": {
    "current_page": 1,
    "rows_per_page": 30
  }
}

Webhook para Transações Pendentes

Webhook que servirá para avisar sobre conclusão de transações que foram originalmente respondidas como pendentes ( retornaram com http status 202).

Webhook Request Body

Request Body: Transação Enviada

{
  "webhook_type": "baas.pix_transfer.outgoing_pix",
  "webhook_datetime": "2021-10-22T20:30:23.459Z",
  "data": {
    "request_control_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
    "pix_transfer_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
    "pix_transfer_status": "sent",
    "created_at": "2021-10-22T20:30:23.459Z"
  }
}

Request Body: Transação Rejeitada

{
  "webhook_type": "baas.pix_transfer.outgoing_pix",
  "webhook_datetime": "2021-10-22T20:30:23.459Z",
  "data": {
    "request_control_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
    "pix_transfer_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
    "pix_transfer_status": "rejected",
    "created_at": "2021-10-22T20:30:23.459Z",
    "error_code": "PXT000132",
    "error_description": "Target account number is invalid.",
    "error_translation": "Número da conta de destino é inexistente ou inválido.",
    "error_short_description": null
  }
}

Webhook Body Param

Campo	Tipo	Descrição	Max. Caracteres
webhook_type	string	Um enumerador que define o tipo de evento sendo reportado	23
webhook_datetime	string	Data e hora do envio do webhook	20
request_control_key	string	UUID4 para fins de consulta sobre a requisição feita.	36
pix_transfer_key	string	Chave de identificação da transferência Pix no sistema QI	36
pix_transfer_status	string	Status da transação.	200
created_at	string	Data e hora de criação da transação.	20

Webhook para Pix de Entrada

Webhook que servirá para avisar sobre transações Pix que chegaram para uma conta.

Webhook Request Body

Request Body: Pix Recebido

{
  "webhook_type": "baas.pix_transfer.incoming_pix",
  "webhook_datetime": "2021-10-22T20:30:23.459Z",
  "data": {
    "pix_transfer_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
    "end_to_end_id": "E18236120202308111235s14fddf2801",
    "pix_transfer_status": "received",
    "account_key": "7c5a1425-73eb-420e-b4fb-0ce3386c7d0c",
    "receiver_conciliation_id": "745c28c780bc4822bbade86dd875d10b",
    "transfer_amount": 126.97,
    "fee_amount": 0.0,
    "source_account": {
      "account_branch": "0001",
      "account_digit": "3",
      "account_number": "12345678",
      "owner_document_number": "***02502000***",
      "owner_person_type": "legal",
      "owner_name": "Qi Tech",
      "account_type": "checking_account",
      "ispb": "32402502"
    },
    "pix_transfer_type": "dynamic_qr_code",
    "pix_message": "pix message received",
    "created_at": "2021-10-22T20:30:23.459Z",
    "reversals": []
  }
}

Webhook Body Param

Campo	Tipo	Descrição	Max. Caracteres
webhook_type	string	Um enumerador que define o tipo de evento sendo reportado	23
webhook_datetime	string	Data e hora do envio do webhook	20
pix_transfer_type	enumerator	Tipo do pix realizado	Enumerador pix_transfer_type
target_pix_key	string	Chave pix da conta a ser enviada a transação	100
source_account	Object	Conta destino - Só deve ser enviada em transações do tipo "manual"	Objeto source_account
transfer_amount	number	Valor da transferencia	10
receiver_conciliation_id	string	Identicação de conciliação do recebedor	35
end_to_end_id	string	Chave de idempotência de uma transação Pix - só deve ser enviado se o tipo de transferência for "key"	32
pix_message	string	Mensagem a ser enviada junto à transferência Pix	140
fee_amount	number	Valor da transferencia	10
pix_transfer_status	string	Status da transação pix	10
account_key	string	Chave única de identificação da conta QI	36
pix_transfer_key	string	Chave única de identificação da transferência Pix	36

Enumerador pix_transfer_type

Enumerador	Descrição
manual	Pix utilizando os dados da conta destino
key	Pix utilizando uma chave pix
static_qr_code	Pix utilizando um QR code estático
dynamic_qr_code	Pix utilizando um QR code dinâmico
reversal	Devolução Pix

Objeto source_account

Campo	Tipo	Descrição	Caracteres
account_branch *	string	Agência da conta	6
account_digit *	string	Dígito da conta	1
account_number *	string	Número da conta	20
owner_document_number *	string	CPF ou CNPJ (apenas números) do titular da conta	14
owner_name	string	Nome do titular da conta	150
account_type*	enumerator	Tipo da conta	Enumerador account_type
ispb *	string	Código de oito dígitos que identifica os bancos no sistema de transferência de reserva do Banco Central	8

Enumerador account_type

Enumerador	Descrição
checking_account	Conta Corrente
salary_account	Conta Salário
saving_account	Conta Poupança
payment_account	Conta de Pagamentos

Webhook para Devoluções de Pix

Webhook que servirá para avisar sobre devoluções Pix que chegaram para uma conta.

Webhook Request Body

Request Body: Pix Recebido

{
  "webhook_type": "baas.pix_transfer.incoming_pix",
  "webhook_datetime": "2021-10-22T20:30:23.459Z",
  "data": {
    "pix_transfer_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
    "end_to_end_id": "E18236120202308111235s14fddf2801",
    "pix_transfer_status": "received",
    "account_key": "7c5a1425-73eb-420e-b4fb-0ce3386c7d0c",
    "receiver_conciliation_id": "745c28c780bc4822bbade86dd875d10b",
    "transfer_amount": 126.97,
    "fee_amount": 0.0,
    "source_account": {
      "account_branch": "0001",
      "account_digit": "3",
      "account_number": "12345678",
      "owner_document_number": "***02502000***",
      "owner_person_type": "legal",
      "owner_name": "Qi Tech",
      "account_type": "checking_account",
      "ispb": "32402502"
    },
    "pix_transfer_type": "reversal",
    "pix_message": "pix message received",
    "created_at": "2021-10-22T20:30:23.459Z",
    "reversals": [],
    "original_outgoing_pix_transfer": "b56862c4-2b20-4057-8063-b8809866e494"
  }
}

Webhook Body Param

Campo	Tipo	Descrição	Max. Caracteres
webhook_type	string	Um enumerador que define o tipo de evento sendo reportado	23
webhook_datetime	string	Data e hora do envio do webhook	20
pix_transfer_type	enumerator	Tipo do pix realizado	Enumerador pix_transfer_type
target_pix_key	string	Chave pix da conta a ser enviada a transação	100
source_account	Object	Conta destino - Só deve ser enviada em transações do tipo "manual"	Objeto source_account
transfer_amount	number	Valor da transferencia	10
receiver_conciliation_id	string	Identicação de conciliação do recebedor	35
end_to_end_id	string	Chave de idempotência de uma transação Pix - só deve ser enviado se o tipo de transferência for "key"	32
pix_message	string	Mensagem a ser enviada junto à transferência Pix	140
fee_amount	number	Valor da transferencia	10
pix_transfer_status	string	Status da transação pix	10
account_key	string	Chave única de identificação da conta QI	36
pix_transfer_key	string	Chave única de identificação da transferência Pix	36
original_outgoing_pix_transfer	string	Chave única de identificação da transferência Pix de saída Original	36

Enumerador pix_transfer_type

Enumerador	Descrição
manual	Pix utilizando os dados da conta destino
key	Pix utilizando uma chave pix
static_qr_code	Pix utilizando um QR code estático
dynamic_qr_code	Pix utilizando um QR code dinâmico
reversal	Devolução Pix

Objeto source_account

Campo	Tipo	Descrição	Caracteres
account_branch	string	Agência da conta	6
account_digit	string	Dígito da conta	1
account_number	string	Número da conta	20
owner_document_number	string	CPF ou CNPJ (apenas números) do titular da conta	14
owner_name	string	Nome do titular da conta	150
account_type	enumerator	Tipo da conta	Enumerador account_type
ispb	string	Código de oito dígitos que identifica os bancos no sistema de transferência de reserva do Banco Central	8

Enumerador account_type

Enumerador	Descrição
checking_account	Conta Corrente
salary_account	Conta Salário
saving_account	Conta Poupança
payment_account	Conta de Pagamentos