跳到主要内容

列出账户的转账记录

请求

ENDPOINT
/account/ACCOUNT_KEY/pix_transfers
方法
GET

Path Params

字段类型描述字符数
account_key *uuidv4QI 账户的唯一标识键36

Query Params

字段类型描述字符数
pix_transfer_directionenumerator交易方向指示(入账或出账)。如果未发送,则默认为 outgoingEnumeradores pix_transfer_direction
request_control_keyuuidv4客户端使用的请求唯一标识键。36
end_to_end_idstringPix 交易的幂等键32
transaction_keyuuidv4账户交易的标识键36
order_bystring"asc" 表示升序,"desc" 表示降序。默认为 "asc"
date_fromstring开始日期。格式 "YYYY-MM-DD"
date_tostring结束日期。格式 "YYYY-MM-DD"
pageinteger请求的页码。默认值为 1
page_sizeinteger查询中请求的每页大小。默认值和最大值均为 30最大值为 30

Enumeradores pix_transfer_direction

枚举值描述
incoming入账 Pix 转账
outgoing出账 Pix 转账

响应

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": {}
}
HTTP 状态码QI 代码
code
标题
title
描述(英文)
Description
描述(葡文)
translation
400PXT000075Pix Transfer Key or End To End Not ProvidedNo pix transfer key or end to end id provided.Não foram fornecidos uma pix transfer key ou end to end id.
404PXT000023Outgoing PIX Transfer Not FoundPix transfer key {pix_transfer_key} was not foundTransferência PIX de saída com chave {pix_transfer_key} não foi encontrada.
403PIT000001User 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