Pesquisar por transferência Pix de saída

Request

ENDPOINT

/baas/pix/pix_transfer

MÉTODO

GET

Path params

Campo	Tipo	Descrição	Caracteres
end_to_end_id	string	chave de identificação única de uma transação ou consulta no Banco Central. Exemplo: E3240250220210615135810450327042	32
pix_transfer_key	string	chave de identificação da transferência Pix no sistema QI (UUIDv4)	36

info

É obrigatório enviar end_to_end_id ou pix_transfer_key, sendo apenas um deles obrigatório.

Atenção

Será apenas permitida a visualização de uma transferência caso o requisitante tenha permissões na conta de saída da transação. Caso o contrário um erro será retornado.

Response

STATUS

200

Response Body

{
	"billing_account_key": null,
	"created_at": "2021-03-12T20:39:06",
	"description": null,
	"end_to_end_id": "E3240250220210615135810450327042",
	"external_analysis": null,
	"fee_amount": 2.0,
	"initiator_document_number": null,
	"pix_message": null,
	"pix_transfer_key": "2c7e71f6-d2a3-4f2d-8243-9b28523e9c95",
	"pix_transfer_status": "rejected",
	"pix_transfer_type": "key",
	"receiver_conciliation_id": null,
	"sent_at": null,
	"source_account_key": "23a4a2c8-9d82-4ebe-a90d-44fe8d839ec0",
	"target_account": {
		"account_branch": "0001",
		"account_digit": "6",
		"account_number": "99031",
		"account_type": null,
		"financial_institution_compe_number": 341,
		"financial_institution_name": "ITAÚ UNIBANCO S.A.",
		"is_internal": false,
		"ispb_number": "60701190",
		"owner_document_number": "40569499801",
		"owner_name": "Nuno Reis",
		"target_pix_key": "rafaell@yopmail.com"
	},
	"transaction_key": "2ddc2843-5930-460f-9a3c-436f40ecc5f1",
	"transfer_amount": 10.0,
	"transfer_purpose": "transfer",
	"update_at": null
}

STATUS

400

Response Body: Parâmetros obrigatórios faltantes

{
    "title": "Pix Transfer Key or End To End Not Provided",
    "description": "No pix transfer key or end to end id provided.",
    "translation": "Não foram fornecidos uma pix transfer key ou end to end id.",
    "code": "PXT000075"
}

STATUS

404

Response Body: Transferência Pix não encontrada por end_to_end_id

{
    "title": "Outgoing PIX Transfer Not Found",
    "description": "Pix transfer end to end id \{end_to_end_id\} was not found",
    "translation": "Transferência PIX de saída com identificador único \{end_to_end_id\} não foi encontrada",
    "code": "PXT000073"
}

STATUS

404

Response Body: Transferência Pix não encontrada por pix_transfer_key

{
    "title": "Outgoing PIX Transfer Not Found",
    "description": "Pix transfer key \{pix_transfer_key\} was not found",
    "translation": "Transferência PIX de saída com chave \{pix_transfer_key\} não foi encontrada.",
    "code": "PXT000023"
}

STATUS

403

Response Body: Usuário não possui credenciais

{
    "title": "User is not allowed to do this transaction",
    "description": "User is not allowed to do this transaction",
    "translation": "Usuário não tem autorização para fazer essa transação",
    "code": "PIT000001"
}

Enumeradores PixTransfer Status

Enumerador	Descrição
sent	Tranferência enviada
rejected	Tranferência rejeitada
pending_confirmation	Tranferência pendente de confirmação
pending_approval	Tranferência pendente de aprovação
error	Tranferência com erro