Skip to main content

Consult Transactions (Statement)

Request​

ENDPOINT
/account/ACCOUNT_KEY/transaction
METHOD
GET

Request Path Params​

FieldTypeDescription
account_key *stringUnique key for identifying the QI account

Query Params​

FieldTypeDescription
date_fromstringStart date. Format "YYYY-MM-DD"
date_tostringEnd date. Format "YYYY-MM-DD"
order_bystring"asc" for ascending order or "desc" for descending order. "desc" by default
pageintegerRequested page number. 1 by default
page_sizeintegerRequested page size in the query. 4000 by default

Response​

STATUS
200
About the Transaction Details field

This field is an object with specific information regarding the type of transaction performed (bank slip payment, TED, or Pix).

Response Body: Pix Transactions
{
    "data": [
        {
            "account_balance": 22403.11,
            "agent_person_key": null,
            "created_at": "2023-11-24 19:10:54",
            "description": "329 0001 000002-5 32.402.502/0001-35 QI SOCIEDADE DE CR\u00c9DITO DIRETO S.A.",
            "origin_key": "4983e0ad-2212-44f9-8ab9-c243f72f90a8",
            "source_subtype": {
                "enumerator": "internal_pix_transfer",
                "translation_ptbr": "Transfer\u00eancia de PIX"
            },
            "transacted_at": "2023-11-24 19:10:54",
            "transaction_amount": 1,
            "transaction_details": {
                "payer_account_branch": "0001",
                "payer_account_digit": "7",
                "payer_account_number": "5267641",
                "payer_document_number": "98765432100",
                "payer_ispb": "32402502",
                "payer_name": "Eduardo Spada",
                "receiver_account_branch": "0001",
                "receiver_account_digit": "5",
                "receiver_account_number": "000002",
                "receiver_conciliation_id": null,
                "receiver_document_number": "32402502000135",
                "receiver_ispb": "32402502",
                "receiver_name": "QI SCD S.A."
            },
            "transaction_key": "b71ea9a3-e012-4761-bea6-e65c6bfc228f"
        }
    ],
    "pagination": {
        "current_page": 1,
        "next_page": null,
        "rows_per_page": 30,
        "total_pages": "unavailable",
        "total_rows": null
    }
}
Response Body: TED Transactions
{
    "data": [
        {
            "account_balance": 22403.11,
            "agent_person_key": null,
            "created_at": "2023-11-24 19:10:54",
            "description": "329 0001 000002-5 32.402.502/0001-35 QI SOCIEDADE DE CR\u00c9DITO DIRETO S.A.",
            "origin_key": "4983e0ad-2212-44f9-8ab9-c243f72f90a8",
            "source_subtype": {
                "enumerator": "incoming_funds_transfer",
                "translation_ptbr": "Transferência de Entrada"
            },
            "transacted_at": "2023-11-24 19:10:54",
            "transaction_amount": 1,
            "transaction_details": {
                "receiver_account_number": "7212399",
                "payer_account_branch": "120",
                "payer_account_number": "84598",
                "receiver_name": "QI SCD S.A.",
                "receiver_account_branch": "2",
                "payer_document_number": "23846749289329",
                "payer_account_digit": "4",
                "payer_ispb": "61231190",
                "receiver_ispb": "32402502",
                "receiver_document_number": "02983510938761",
                "payer_name": "ASICS BRASIL DISTRIBUICAO E CO",
                "receiver_account_digit": "3"
            },
            "transaction_key": "b71ea9a3-e012-4761-bea6-e65c6bfc228f"
        }
    ],
    "pagination": {
        "current_page": 1,
        "next_page": null,
        "rows_per_page": 30,
        "total_pages": "unavailable",
        "total_rows": null
    }
}
Response Body: Pix Payment Transactions
{
    "data": [
        {
            "account_balance": 22403.11,
            "agent_person_key": null,
            "created_at": "2023-11-24 19:10:54",
            "description": "329 0001 000002-5 32.402.502/0001-35 QI SOCIEDADE DE CR\u00c9DITO DIRETO S.A.",
            "origin_key": "4983e0ad-2212-44f9-8ab9-c243f72f90a8",
            "source_subtype": {
                "enumerator": "bank_slip_payment",
                "translation_ptbr": "Pagamento de Boleto"
            },
            "transacted_at": "2023-11-24 19:10:54",
            "transaction_amount": 1,
            "transaction_details": {
                "beneficiary_legal_name": "COATIOSUERRA LTDA",
                "barcode": "34191954500001165778979877821520910001098000",
                "digitable_line": "34312123124532455091500010980001195450000116579",
                "beneficiary_document_number": "61148052000102"
            },
            "transaction_key": "b71ea9a3-e012-4761-bea6-e65c6bfc228f"
        }
    ],
    "pagination": {
        "current_page": 1,
        "next_page": null,
        "rows_per_page": 30,
        "total_pages": "unavailable",
        "total_rows": null
    }
}
Response Body: Card Settlement Transactions
{
    "data": [
        {
            "account_balance": 22403.11,
            "agent_person_key": null,
            "created_at": "2023-11-24 19:10:54",
            "description": "Nome da Credenciadora 12345678000195 - Elo Débito - Liquidação",
            "origin_key": "4983e0ad-2212-44f9-8ab9-c243f72f90a8",
            "source_subtype": {
                "enumerator": "incoming_debit_card_settlement",
                "translation_ptbr": "Liquidação de cartão de débito"
            },
            "transacted_at": "2023-11-24 19:10:54",
            "transaction_amount": 1,
            "transaction_details": {
                "merchant_name": "Nome do Merchant",
                "merchant_document_number": "87654321000198",
                "acquirer_name": "Nome da Credenciadora",
                "acquirer_document_number": "12345678000195",
                "product_type": "ECD",
                "product_description": "Elo Débito"
            },
            "transaction_key": "b71ea9a3-e012-4761-bea6-e65c6bfc228f"
        }
    ],
    "pagination": {
        "current_page": 1,
        "next_page": null,
        "rows_per_page": 30,
        "total_pages": "unavailable",
        "total_rows": null
    }
}
Response Body: Card Purchase Transactions
{
    "data": [
        {
            "account_balance": 20003.01,
            "agent_person_key": null,
            "created_at": "2023-11-24 19:10:54",
            "description": "Cartão físico | Nome do Estabelecimento | SAO PAULO - BR | U3UUUU",
            "origin_key": "c9f31beb-dafa-42c2-9a16-0854c523eabd",
            "source_subtype": {
                "enumerator": "card_purchase",
                "translation_ptbr": "Compra com Cartão"
            },
            "transacted_at": "2023-11-24 19:10:54",
            "transaction_amount": 17,
            "transaction_details": {
                "acquirer_code": "000000",
                "merchant_mcc": "0000",
                "merchant_name": "Nome do Estabelecimento",
                "authorization_code": "U3UUUU",
                "merchant_address": {
                    "postal_code": "00000123",
                    "city": "SAO PAULO",
                    "country": "BR"
                },
                "merchant_currency": "BRL",
                "merchant_amount": "17.00",
                "card_transaction_type": "purchase",
                "card_type": "plastic"
            },
            "transaction_key": "b71ea9a3-e012-4761-bea6-e65c6bfc228f"
        }
    ],
    "pagination": {
        "current_page": 1,
        "next_page": null,
        "rows_per_page": 30,
        "total_pages": "unavailable",
        "total_rows": null
    }
}
Attention!

The field product_type contained in the transaction_details object of Credit Card Settlement Transactions is a field informed by the Card Settlement System and may be returned with the value null. For these cases, the product_description field should be read to identify the settlement product_type.

Enumerators product_type​

EnumeratorDescription
ACCAmerican Express Crédito
BCCBanescard Crédito
BCDBanescard Débito
BVVBen Visa Vale Pré-pago
CACCielo Amex Crédito
CBCCabal Crédito
CBDCabal Débito
CBPCabal Pré-pago
CC3Central de Cessões de Crédito
CDCCielo Diners Cartão de Crédito
CECCielo Elo Cartão de Crédito
CEDCielo Elo Cartão de Débito
CHCCielo Hipercard Crédito
CMCCielo Mastercard Crédito
CMDCielo Mastercard Débito
COPCOPASA - Companhia de Saneamento de Minas Gerais
CUPCup Crédito
CZCCredz Crédito
DCCLiquidações Transfronteiriças Diners Crédito
ECBElo PAT - Cartão de Benefícios
ECCElo Crédito
ECDElo Débito
GCCGoodcard Crédito
GDCGlobal Payments Diners Crédito
GMCGlobal Payments MasterCard Crédito
GMDGlobal Payments MasterCard Débito
GVCGlobal Payments VISA Crédito
GVDGlobal Payments VISA Débito
HCCHipercard Crédito
HCDHiper Débito
JCCJCB Crédito
MACMais Cartão de Crédito
MCAMasterCard Cartão ATM
MCCMastercard Crédito
MCDMaestro Débito
MCPMastercard Pré-pago
NBANeoenergia - Companhia de Eletricidade do Estado da Bahia
NBRNeoenergia - Distribuição Brasília S.A
NEKNeoenergia - Elektro Redes S/A
NPENeoenergia - Companhia Energética de Pernambuco
NRNNeoenergia - Companhia Energética do Rio Grande do Norte
OCDOurocard Débito
OTProduto Liquidação Outras Transferências
PCAPlataforma Centralizada de Arrecadação
SCCSorocred Crédito
SCDSorocred Débito
SLCServiço de Liquidação Centralizada
STCSELTEC
TCBTecban
TEDProduto Liquidação TED
VCAVisa Cartão ATM
VCCVisa Crédito
VCDVisa Electron Débito
VCPVisa Pré-pago
VDCVerdecard Crédito
VDPVerdecard Pré-pago
VIAVisa Internacional Saque ATM
VICVisa Internacional Compra Crédito
VIDVisa Internacional Compra Débito
Alelo Pré-pago
Agiplan Crédito
Aura Crédito
Calcard Crédito
Credsystem Crédito
Redesplan Crédito
Sicred Crédito
Avista Crédito
Discover Crédito
Sicredi Débito
Hiper Crédito
Ticket Pré-pago
Sodexo Pré-pago
VR Pré-pago
Policard Pré-pago
Valecard Pré-pago
Greencard Pré-pago
Coopercard Pré-pago
Verocheque Pré-pago
Nutricash Pré-pago
Banricard Pré-pago
Socored Pré-pago
Cielo Arranjo Fechado Crédito
Cielo Arranjo Fechado Débito

Enumerators for source_sub_type​

EnumDescription
operation_disbursementOperation Disbursement
protest_expenseProtest Expenses
automatic_integrated_paymentAutomatic Integrated Payment
taxTaxes
electronic_funds_feeTED Fee
credit_operation_feeCredit Opening Fee
internal_funds_transferInternal Transfer
incoming_funds_transferIncoming Transfer
outgoing_funds_transferTED
depositDeposit
withdrawalWithdrawal
withdrawal_reversalWithdrawal Reversal
trade_funds_transferAssignment Payment Transfer
settlement_funds_transferSettlement Transfer
bank_slip_feeBank Slip Fee
bank_slip_settlementBank Slip Settlement
outgoing_funds_transfer_reversalTED Reversal
incoming_funds_transfer_refusalTransfer Refused
electronic_funds_fee_reversalTED Fee Reversal
monthly_account_fee_reversalAccount Maintenance Fee Reversal
bank_slip_fee_reversalBank Slip Fee Reversal
correspondent_bank_transferCorrespondent Bank Transfer
credit_analysis_feeCredit Analysis Fee
credit_operation_fee_reversalCredit Opening Fee Reversal
financial_investments_incomeFinancial Application Income
bank_slip_settlement_reversalBank Slip Settlement Reversal
bank_slip_settlement_expense_reversalBank Slip Settlement Fee Reversal
bank_slip_settlement_incoming_reversalBank Slip Settlement Incoming Reversal
correspondent_bank_transfer_reversalCorrespondent Bank Transfer Reversal
credit_analysis_fee_reversalCredit Analysis Fee Reversal
doc_expense_reversalDOC Fee Reversal
incoming_doc_reversalDOC Incoming Reversal
operation_disbursement_reversalOperation Disbursement Reversal
operation_settling_reversalOperation Payment Reversal
outgoing_doc_reversalDOC Outgoing Reversal
rebate_reversalRebate Reversal
settlement_funds_transfer_reversalSettlement Transfer Reversal
tax_reversalTax Reversal
trade_funds_transfer_reversalAssignment Payment Transfer Reversal
bank_slip_permanency_feeTitle Permanence Fee
bank_slip_cancel_protest_feeTitle Permanence Fee
bank_slip_protest_feeProtest Request Fee
bank_slip_notary_office_feeProtest Costs
bank_slip_registration_feeRegistration Fee
bank_slip_extension_feeExtension Fee
bank_slip_rebate_feeRebate Fee
bank_slip_discount_feeDiscount Fee
bank_slip_settlement_feeSettlement Fee
bank_slip_write_off_term_feeWrite-off Due Date Fee
bank_slip_write_off_feeWrite-off Fee
bank_slip_cancel_protest_write_off_feeProtest Sustenance with Write-off Fee
bank_slip_notary_office_settlement_feeNotarial Office Settlement Fee
rebate_tax_freePass-through Settlement
rebate_tax_free_reversalPass-through Settlement Reversal
incoming_funds_transfer_reversalInternal Transfer Reversal
bank_slip_paymentBank Slip Payment
bank_slip_payment_reversalBank Slip Payment Reversal
warranty_analysis_feeGuarantee Analysis Fee
bank_slip_settlement_depositBank Slip Settlement
bank_slip_payment_withdrawalBank Slip Payment
account_setup_feeAccount Opening Fee
account_setup_fee_reversalAccount Opening Fee Reversal
bank_slip_payment_withdrawal_reversalBank Slip Payment Reversal
incoming_anticipation_of_receivable-
incoming_credit_card_settlementCredit Card Settlement
incoming_debit_card_settlementDebit Card Settlement
assignment_automatic_transferAutomatic Assignment Debit
assignment_automatic_transfer_reversalAutomatic Assignment Debit Reversal
pix_feePIX Fee
pix_fee_reversalPIX Fee Reversal
pix_depositPIX Deposit
pix_withdrawalPIX Transfer
pix_withdrawal_reversalPIX Transfer Reversal
pix_chargeback_withdrawalPIX Chargeback Sending
outgoing_pix_chargebackPIX Chargeback Outgoing
incoming_pix_chargebackPIX Chargeback Incoming
pix_chargeback_depositPIX Chargeback Deposit
pix_chargeback_withdrawal_reversalPIX Chargeback Sending Reversal
outgoing_pix_chargeback_reversalPIX Chargeback Outgoing Reversal
incoming_pix_chargeback_reversalPIX Chargeback Incoming Reversal
operation_pix_disbursementPIX Operation Disbursement
operation_pix_disbursement_reversalPIX Operation Disbursement Reversal
receivables_inquiry_feeReceivables Agenda Inquiry Fee
pix_deposit_reversalPIX Deposit Reversal
internal_pix_transferPIX Transfer
automatic_integrated_payment_reversalAutomatic Integrated Payment Reversal
operation_dibursement_reversalOperation Disbursement Reversal
available_yieldNet Investment Deposit
bank_slip_convenant_paymentAgreement Bank Slip Payment

Enumerators prepaid_card_transaction_type​

EnumDescription
purchasePurchase on card
international_purchaseInternational purchase on card
withdrawalATM withdrawal on card

Enumerators card_type​

EnumDescription
plasticPhysical card
virtualVirtual card