List Transfers of an Account

Request

ENDPOINT

/account/ACCOUNT_KEY/pix_transfers

METHOD

GET

Path Params

Field	Type	Description	Characters
account_key *	uuidv4	Unique identification key of the QI account.	36

Query Params

Field	Type	Description	Characters
pix_transfer_direction	enumerator	Indicator of the transaction direction (inbound or outbound). If not sent, outgoing will be considered	Enumerators pix_transfer_direction
request_control_key	uuidv4	Unique request identification key used by the client.	36
end_to_end_id	string	Idempotency key of a Pix transaction	32
transaction_key	uuidv4	Identification key of the account movement	36
date_from	string	Start date. Format "YYYY-MM-DD"
date_to	string	End date. Format "YYYY-MM-DD"
page	integer	Requested page number. Default is 1
page_size	integer	Requested page size in the query. Default and maximum value is 30	Maximum value of 30

Enumerators pix_transfer_direction

Enumerator	Description
incoming	Inbound Pix transfer
outgoing	Outbound Pix transfer

Response

STATUS

201

Response Body

{
  "data": [
    {
      "request_control_key": "6e290347-330d-4b3a-8ebb-2ac217ad6eb3",
      "pix_message": "Guten tag!",
      "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",
      "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": "title",
  "description": "description in English",
  "translation": "description in Portuguese",
  "code": "code",
  "extra_fields": {}
}

HTTP Code	QI Code code	Title title	Description (eng) Description	Description (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