Get Bank Statement (v2)
GET {{url_contbank}}/partner-bff/s2s/bank-statements?page=1&per_page=15&branch={{branch_number}}&account={{account_number}}&begin_date_time=2024-05-01T00:00:00.0000000Z&end_date_time=2024-05-31T00:00:00.0000000Z
API de extrato : retorna os dados agrupados por data, além do saldo diário.
Response Schema
| Campo | Descrição |
|---|---|
| page | Número da página retornada. Página atual. |
| per_page | Quantidade de registros por página. Este valor é enviado no request. |
| hasnextpage | Valor booleano. Indica se há uma próxima página a ser retornada. Se o valor indicado for false, significa que não há próxima página. Se o valor for true, há uma nova página. |
| itens | Lista das transações retornadas para os filtros aplicados. |
| itens.aggregate_id | Valor chave da transação. |
| itens.document_number | CPF/CNPJ da conta. |
| itens.bank_branch | Agência da conta. |
| itens.bank_account | Número da conta. |
| itens.amount | Valor da transação. |
| itens.name | Tipo da transação. |
| itens.timestamp | Data e hora da transação. |
| itens.label | Descrição da transação. |
| itens.data | Dados extras referente a transação. Os campos e valores contidos neste objeto diferem dependendo do tipo de transação. |
| itens.data.conciliation_description | Descrição da transação. Essa descrição também é utilizada no arquivo OFX. Pode ser utilizado para conciliar API e OFX. |
| itens.data.recipient_account | Dados do emitente da transação. |
| itens.data.sender_account | Dados do destinatário da transação. |
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
page | number | Pagina atual. Campo obrigatório. | |
per_page | number | Registros por página. Campo obrigatório. | |
branch | string | Número da agencia. Campo obrigatório. | |
account | string | Número da conta. Campo obrigatório. Não é o Account ID. | |
begin_date_time | string | Periodo inicial da consulta. O período máximo deve ser de 90 (noventa) dias. | |
end_date_time | string | Periodo final da consulta. O período máximo deve ser de 90 (noventa) dias. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
X-Current-Identity | number | CPF/CNPJ do usuário |
RESPONSES
status: OK
{"page":1,"per_page":10,"has_next_page":true,"statements":[{"date":"2024-05-09","value":11.91,"itens":[{"aggregate_id":"TRANSACTION_ID_116277cd-3b7c-4603-8816-aa2a0a796ec8","type":"TRANSACTION","category":"EletronicTransfers","document_number":"12345678901","bank_branch":"0001","bank_account":"11692537","amount":0.07,"name":"CASH_IN_ACCOUNT","timestamp":"2024-05-09T18:23:26Z","label":"TED Recebido","data":{"address_key":null,"amount_details":null,"authentication_code_external":null,"channel":"INTERNAL","clearing_amount":0.07,"company_key":"CONTBANK","conciliation_description":"TED Recebido NOME DO REMETENTE ******77020 Agência:0001 Conta:441183506","conciliation_id":null,"control_number":null,"correlation_id":"67064285-313c-4118-a897-3e93cc9a3795","deposit_transaction_id":"116277cd-3b7c-4603-8816-aa2a0a796ec8","description":"TESTE","document":"12345678901","end_to_end_id":null,"event_date_time":"2024-05-10T00:23:26+00:00","is_pix_deposit":false,"is_tax_deposit":false,"is_tax_refund_deposit":false,"over_limit_amount":0,"pix_transaction_id":"00000000-0000-0000-0000-000000000000","recipient_account":{"account":"11692537","agency":"0001","document":"12345678901","ispb_number":"13140088","name":"NOME DO REMETENTE"},"sender_account":{"account":"441183506","agency":"0001","document":"80278477020","ispb_number":"13140088","name":"NOME DO DESTINATÁRIO"},"transaction_amount":0.07,"withdrawal_agent_type":null,"withdrawal_provider_ispb":null},"status":"","year":0,"month":0,"initial_balance":11.84,"final_balance":11.91},{"aggregate_id":"TRANSACTION_ID_63f8b15a-5099-4ef2-bd6b-2cd5e09b06c0","type":"TRANSACTION","category":"EletronicTransfers","document_number":"12345678901","bank_branch":"0001","bank_account":"11692537","amount":-0.05,"name":"CASH_OUT_ACCOUNT","timestamp":"2024-05-09T18:08:28.006Z","label":"TED Enviado","data":{"conciliation_description":"TED Enviado NOME DO DESTINATÁRIO ******77020 Acesso Soluções De Pagamento S.A. - Instituição De Pagamento Agência:0001 Conta:441183506","transaction_receipt":{"amount":-0.05,"authentication_code":"63f8b15a-5099-4ef2-bd6b-2cd5e09b06c0","control_number":null,"description":"TESTE TED","destination_account":"441183506","destination_agency":"0001","destination_bank_name":"Acesso Soluções De Pagamento S.A. - Instituição De Pagamento","destination_compe":"332","destination_document":"80278477020","destination_name":"NOME DO DESTINATÁRIO","transaction_date":"2024-05-10T00:08:28.0062021Z"}},"status":"","year":0,"month":0,"initial_balance":11.89,"final_balance":11.84},{"aggregate_id":"TRANSACTION_ID_9fd275c5-66ce-4c3a-8412-37c358340a03","type":"TRANSACTION","category":"EletronicTransfers","document_number":"12345678901","bank_branch":"0001","bank_account":"11692537","amount":-0.02,"name":"CASH_OUT_ACCOUNT","timestamp":"2024-05-09T17:53:17.021Z","label":"TED Enviado","data":{"conciliation_description":"TED Enviado NOME DO DESTINATÁRIO ******77020 Acesso Soluções De Pagamento S.A. - Instituição De Pagamento Agência:0001 Conta:441183506","transaction_receipt":{"amount":-0.02,"authentication_code":"9fd275c5-66ce-4c3a-8412-37c358340a03","control_number":null,"description":"TESTE TED CASH IN","destination_account":"441183506","destination_agency":"0001","destination_bank_name":"Acesso Soluções De Pagamento S.A. - Instituição De Pagamento","destination_compe":"332","destination_document":"80278477020","destination_name":"NOME DO DESTINATÁRIO","transaction_date":"2024-05-09T23:53:17.0213831Z"}},"status":"","year":0,"month":0,"initial_balance":11.91,"final_balance":11.89},{"aggregate_id":"PIX_TRANSACTION_ID_9055f30a-f57b-464c-a877-1a11840eec71","type":"TRANSACTION","category":"EletronicTransfers","document_number":"12345678901","bank_branch":"0001","bank_account":"11692537","amount":0.01,"name":"PIX_CASH_IN_ACCOUNT","timestamp":"2024-05-09T17:49:05Z","label":"Pix Recebido","data":{"address_key":null,"amount_details":null,"authentication_code_external":null,"channel":"INTERNAL_SPI","clearing_amount":0.01,"company_key":"CONTBANK","conciliation_description":"Pix Recebido NOME DO REMETENTE ******77020 Agência:0001 Conta:441183506","conciliation_id":null,"control_number":null,"correlation_id":"967ce40d-940c-4f92-afd7-589d2f6e1177","deposit_transaction_id":"9055f30a-f57b-464c-a877-1a11840eec71","description":"Teste pix cash out","document":"12345678901","end_to_end_id":"E1314008820240509234986c4620058d","event_date_time":"2024-05-09T23:49:05+00:00","is_pix_deposit":true,"is_tax_deposit":false,"is_tax_refund_deposit":false,"over_limit_amount":0,"pix_transaction_id":"00000000-0000-0000-0000-000000000000","recipient_account":{"account":"11692537","agency":"0001","document":"12345678901","ispb_number":"13140088","name":"NOME DO REMETENTE"},"sender_account":{"account":"441183506","agency":"0001","document":"80278477020","ispb_number":"13140088","name":"NOME DO DESTINARÁRIO"},"transaction_amount":0.01,"withdrawal_agent_type":null,"withdrawal_provider_ispb":null},"status":"","year":0,"month":0,"initial_balance":11.9,"final_balance":11.91},{"aggregate_id":"PAYBILL_02c79680-6475-4fbc-847c-11703f9d166b","type":"TRANSACTION","category":"AccountPayment","document_number":"12345678901","bank_branch":"0001","bank_account":"11692537","amount":-5,"name":"PAYBILL","timestamp":"2024-05-09T17:45:03.613Z","label":"Pagamento efetuado","data":{"amount":5,"assignor":"BANCO VOTORANTIM S.A.","authentication_code":"02c79680-6475-4fbc-847c-11703f9d166b","bank_account":"11692537","bank_branch":"0001","bank_code":"332","bank_ispb":"13140088","bank_name":"Acesso Soluções de Pagamento S.A.","charges":{"discount_amount":0,"fine_amount_calculated":0,"interest_amount_calculated":0},"company_key":"CONTBANK","conciliation_description":"Pagamento efetuado BANCO VOTORANTIM S.A.","confirmation_transaction_id":2426270401,"confirmed_at":null,"correlation_id":"a309809e-a8b8-49ce-bd6e-408521bf5bc2","created_at":"2024-05-09T23:45:03.6132623Z","description":"TESTE PAGAMENTO","digitable":"65590000020806150000800381893007397170000000500","document_number":"12345678901","due_date":"2024-05-15T00:00:00Z","has_uncommitted_events":true,"id":"02c79680-6475-4fbc-847c-11703f9d166b","original_amount":5,"payment_date":"2024-05-09T23:45:03.6132735Z","payment_status":"Created","payment_type":"Bill","reason_refused":null,"recipient_document":"13.140.088/0001-99","recipient_name":"ACESSO SOLUCOES DE PAGAMENTO SA INSTITUICAO DE PAG","requested_at":"2024-05-09T23:45:03.6132621Z","settle_date":"2024-05-09T00:00:00Z","transaction_id":2426267970,"type":"Compensation","updated_at":"2024-05-09T23:45:05.3560631Z","version":2},"status":"","year":0,"month":0,"initial_balance":16.9,"final_balance":11.9},{"aggregate_id":"TRANSACTION_ID_ac066171-b16c-4717-889f-78958a277d82","type":"TRANSACTION","category":"EletronicTransfers","document_number":"12345678901","bank_branch":"0001","bank_account":"11692537","amount":13,"name":"CASH_IN_ACCOUNT","timestamp":"2024-05-09T17:42:46Z","label":"TED Recebido","data":{"address_key":null,"amount_details":null,"authentication_code_external":null,"channel":"INTERNAL","clearing_amount":13,"company_key":"CONTBANK","conciliation_description":"TED Recebido NOME DO REMETENTE 12345678901234 Agência:0001 Conta:11846518","conciliation_id":null,"control_number":null,"correlation_id":"ab329a4d-04fe-4531-a59a-e3fa71ec2eb3","deposit_transaction_id":"ac066171-b16c-4717-889f-78958a277d82","description":"TESTE TED","document":"12345678901","end_to_end_id":null,"event_date_time":"2024-05-09T23:42:46+00:00","is_pix_deposit":false,"is_tax_deposit":false,"is_tax_refund_deposit":false,"over_limit_amount":0,"pix_transaction_id":"00000000-0000-0000-0000-000000000000","recipient_account":{"account":"11692537","agency":"0001","document":"12345678901","ispb_number":"13140088","name":"NOME DO REMETENTE"},"sender_account":{"account":"11846518","agency":"0001","document":"31648759000109","ispb_number":"13140088","name":"NOME DO DESTINATÁRIO"},"transaction_amount":13,"withdrawal_agent_type":null,"withdrawal_provider_ispb":null},"status":"","year":0,"month":0,"initial_balance":3.9,"final_balance":16.9},{"aggregate_id":"PIX_TRANSACTION_ID_35fd18fc-f6db-489d-82d6-d6f9e9127e29","type":"TRANSACTION","category":"EletronicTransfers","document_number":"12345678901","bank_branch":"0001","bank_account":"11692537","amount":-0.09,"name":"PIX_CASH_OUT_ACCOUNT","timestamp":"2024-05-09T17:41:55.552Z","label":"Pix Enviado","data":{"address_key":null,"address_key_type":"","amount":-0.09,"amount_details":null,"authentication_code":"35fd18fc-f6db-489d-82d6-d6f9e9127e29","channel":"INTERNAL","conciliation_description":"Pix Enviado NOME DO REMETENTE ******77020 Acesso Soluções De Pagamento S.A. - Instituição De Pagamento Agência:0001 Conta:441183506","description":"Extrato teste","end_to_end_id":"E131400882024050923417859c038a55","initialization_type":"Manual","recipient":{"bank_account":"441183506","bank_account_type":"CHECKING","bank_branch":"0001","bank_compe":"332","bank_ispb":"13140088","bank_name":"Acesso Soluções De Pagamento S.A. - Instituição De Pagamento","document":"80278477020","document_type":"CPF","name":"NOME DO REMETENTE"},"scheduled_payment_date":null,"transaction_date":"2024-05-09T23:41:58.3539557Z","withdrawal_agent_type":null,"withdrawal_provider_ispb":null},"status":"","year":0,"month":0,"initial_balance":3.99,"final_balance":3.9},{"aggregate_id":"PIX_TRANSACTION_ID_4263932a-5963-4496-bbf1-12e030d53088","type":"TRANSACTION","category":"EletronicTransfers","document_number":"12345678901","bank_branch":"0001","bank_account":"11692537","amount":-0.01,"name":"PIX_CASH_OUT_ACCOUNT","timestamp":"2024-05-09T17:40:51.117Z","label":"Pix Enviado","data":{"address_key":null,"address_key_type":"","amount":-0.01,"amount_details":null,"authentication_code":"4263932a-5963-4496-bbf1-12e030d53088","channel":"INTERNAL","conciliation_description":"Pix Enviado JULIO MARANGONI ******01865 Acesso Soluções De Pagamento S.A. - Instituição De Pagamento Agência:0001 Conta:11738235","description":"Teste extrato","end_to_end_id":"E1314008820240509234053aa096e2c1","initialization_type":"Manual","recipient":{"bank_account":"11738235","bank_account_type":"CHECKING","bank_branch":"0001","bank_compe":"332","bank_ispb":"13140088","bank_name":"Acesso Soluções De Pagamento S.A. - Instituição De Pagamento","document":"37786401865","document_type":"CPF","name":"JULIO MARANGONI"},"scheduled_payment_date":null,"transaction_date":"2024-05-09T23:40:52.2159001Z","withdrawal_agent_type":null,"withdrawal_provider_ispb":null},"status":"","year":0,"month":0,"initial_balance":4,"final_balance":3.99},{"aggregate_id":"TRANSACTION_ID_4ab44ad8-4ee9-4541-9a05-08202c6f416d","type":"TRANSACTION","category":"EletronicTransfers","document_number":"12345678901","bank_branch":"0001","bank_account":"11692537","amount":-0.21,"name":"CASH_OUT_ACCOUNT","timestamp":"2024-05-09T17:40:15.782Z","label":"TED Enviado","data":{"conciliation_description":"TED Enviado NOME DO DESTINATÁRIO ******77020 Acesso Soluções De Pagamento S.A. - Instituição De Pagamento Agência:0001 Conta:441183506","transaction_receipt":{"amount":-0.21,"authentication_code":"4ab44ad8-4ee9-4541-9a05-08202c6f416d","control_number":null,"description":"TESTE EXTRATO","destination_account":"441183506","destination_agency":"0001","destination_bank_name":"Acesso Soluções De Pagamento S.A. - Instituição De Pagamento","destination_compe":"332","destination_document":"80278477020","destination_name":"NOME DO DESTINATÁRIO","transaction_date":"2024-05-09T23:40:15.7823715Z"}},"status":"","year":0,"month":0,"initial_balance":4.21,"final_balance":4},{"aggregate_id":"PIX_TRANSACTION_ID_7ac7b764-c378-44aa-b28f-93a6a3fec9df","type":"TRANSACTION","category":"EletronicTransfers","document_number":"12345678901","bank_branch":"0001","bank_account":"11692537","amount":1.5,"name":"PIX_CASH_IN_ACCOUNT","timestamp":"2024-05-09T17:39:42.792Z","label":"Pix Recebido","data":{"address_key":"1cf646e1-ec69-4624-906e-44593d032fe5","amount_details":null,"authentication_code_external":null,"channel":"SPI","clearing_amount":1.5,"company_key":"CONTBANK","conciliation_description":"Pix Recebido NOME DO REMETENTE ******78901 Agência:0001 Conta:80866239","conciliation_id":null,"control_number":null,"correlation_id":"bd6c3912-7003-4b86-aec2-b02b16a66c89","deposit_transaction_id":"7ac7b764-c378-44aa-b28f-93a6a3fec9df","description":null,"document":"12345678901","end_to_end_id":"E18236120202405092339s01650e210b","event_date_time":"2024-05-09T23:39:42.7925092Z","is_pix_deposit":true,"is_tax_deposit":false,"is_tax_refund_deposit":false,"over_limit_amount":0,"pix_transaction_id":"bd6c3912-7003-4b86-aec2-b02b16a66c89","recipient_account":{"account":"11692537","agency":"0001","document":"12345678901","ispb_number":"13140088","name":null},"sender_account":{"account":"80866239","agency":"0001","document":"12345678901","ispb_number":"18236120","name":"NOME DO DESTINATÁRIO"},"transaction_amount":1.5,"withdrawal_agent_type":null,"withdrawal_provider_ispb":null},"status":"","year":0,"month":0,"initial_balance":2.71,"final_balance":4.21}]}]}