跳到主要内容

获取账户交易记录


Request

ENDPOINT
/cash_account/account/ACCOUNT_KEY/transactions
MÉTODO
GET

Response

STATUS
200
Response Body
{
"data": [
{
"transaction_key": "ed585534-8c05-431d-b829-0dc7883b24ba",
"transaction_type": "outgoing_wire_transfer",
"transaction_status": "pending_conciliation",
"transaction_description": "Descrição do pagamento",
"amount": -70000,
"transaction_datetime": "2025-01-01T14:00:00Z",
"account_balance": 500000,
"transaction_data": {
"counter_part_account": {
"owner": {
"name": "Nome da Contraparte",
"document_number": "***.805.49*-**"
},
"account_digit": "8",
"account_branch": "1",
"account_number": "1234567",
"financial_institution": {
"code": "329",
"ispb": "32402502"
}
},
},
"account": {
"account_key": "9c1d0c18-01ea-4c32-a878-1c6391f9aa44",
"account_type": "checking_account",
"financial_institution": {
"ispb": "32402502",
"code": "329",
"name": "QI Sociedade de Crédito Direto"
},
"account_status": "open",
"account_number": "3289018",
"account_digit": "7",
"account_branch": "0001",
"accounting_identification": 1,
"balance": 500000,
"owner": {
"name": "FUNDO TESTE",
"document_number": "93.625.214/0001-34"
},
"owner_document_number": "93.625.214/0001-34",
"account_configuration": {
"pix": true,
"wire_transfer": true
},
"billings": []
}
},
{
"transaction_key": "16c9c463-266e-4e73-b87d-efc32aa6727a",
"transaction_type": "incoming_wire_transfer",
"transaction_status": "reconciled",
"transaction_description": "Descrição",
"amount": 300000,
"transaction_datetime": "2025-06-04T13:00:00Z",
"account_balance": 570000,
"transaction_data": {
"counter_part_account": {
"owner": {
"name": "FUNDO TESTE",
"document_number": "93.625.214/0001-34"
},
"account_digit": "8",
"account_branch": "73",
"account_number": "567567",
"financial_institution": {
"code": "341",
"ispb": "60701190",
}
},
},
"account": {
"account_key": "9c1d0c18-01ea-4c32-a878-1c6391f9aa44",
"account_type": "checking_account",
"financial_institution": {
"ispb": "32402502",
"code": "329",
"name": "QI Sociedade de Crédito Direto"
},
"account_status": "open",
"account_number": "3289018",
"account_digit": "7",
"account_branch": "0001",
"accounting_identification": 1,
"balance": 500000,
"owner": {
"name": "FUNDO TESTE",
"document_number": "93.625.214/0001-34"
},
"owner_document_number": "93.625.214/0001-34",
"account_configuration": {
"pix": true,
"wire_transfer": true
},
"billings": []
},
"conciliation_group": {
"description": "TRANSFERÊNCIA: CONTA COBRANÇA -> CONTA PRINCIPAL",
"conciliation_group_key": "1ac2921c-6c81-481b-8472-6c4126bba4bf",
"conciliation_group_datetime": "2025-01-01T13:28:58Z"
}
}
],
"limit": 10,
"page": 0,
"is_last_page": true
}

Query Params

字段类型描述
statusstring交易状态
start_datestring查询起始日期
end_datestring查询结束日期
pagestring已返回页码

Response Fields

字段类型描述
dataarrayTransaction 对象列表
limitint每页返回对象数量上限
pageint已返回页码
is_last_pageboolean表示已返回页面是否为最后一页

Transaction

字段类型描述字符数
transaction_keystring交易唯一标识键36
transaction_typestring交易类型最多50
transaction_statusstring交易状态最多50
transaction_descriptionstring银行提供的交易描述最多255
amountbigint交易金额乘以100(例如:R$1,00 == 100)-
transaction_datetimestring交易日期和时间ISO 8601
account_balancebigint交易后账户余额-
transaction_dataJSON含交易附加信息的对象-
accountJSON包含交易的账户对象-

Account

字段类型描述字符数
account_keystring账户唯一标识键36
account_typestring账户类型最多50
financial_institutionJSON金融机构对象-
account_statusstring账户状态最多50
account_numberstring账户号码最多50
account_digitstring账户校验位1
account_branchstring支行编号最多50
accounting_identificationint账户序列标识符-
balanceint当前账户余额-
ownerJSON持有人对象-
owner_document_numberstring持有人证件号14或18
注意

余额通过将元和分拼接提供,例如:1234 = R$ 12,34

Financial institution

字段类型描述字符数
ispbstring巴西支付系统标识符8
codestring金融机构代码3
namestring金融机构名称最多255

Owner

字段类型描述字符数
namestring持有人姓名最多255
document_numberstring持有人证件号14或18

Conciliation Group

字段类型描述字符数
descriptionstring交易对账描述最多255
conciliation_group_keystring对账唯一标识键36
conciliation_group_datetimestring对账日期和时间ISO 8601