Listar Transferências de uma Conta

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
order_by	string	"asc" para ordem ascendente ou "desc" para descendente. "asc" por padrão
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",
        "financial_institution_name": "QI SCD",
        "pix_key": null
      },
      "receiver_conciliation_id": null,
      "pix_transfer_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
      "transaction_key": "848d3ff7-4e98-4911-8773-f1d1b48c3068",
      "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
  }
}

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