Pular para o conteúdo principal

Consulta de Transações

Request​

ENDPOINT
/account/ACCOUNT_KEY/transaction
MÉTODO
GET

Request Path Params​

CampoTipoDescrição
account_key *stringChave única de identificação da conta QI

Query Params​

CampoTipoDescrição
date_fromstringData inicial. Formato "YYYY-MM-DD"
date_tostringData final. Formato "YYYY-MM-DD"
order_bystring"asc" para ordem ascendente ou "desc" para descendente. "desc" por padrão
pageintegerNúmero da página requisitada. 1 por padrão
page_sizeintegerTamanho da página requisitada na consulta. 4000 por padrão

Response​

Success Response​

STATUS
200
Sobre o campo Transaction Details

Este campo é um objeto com informações específicas ao tipo de transação realizada (pagamento de boleto, TED ou Pix).

Response Body: Transações Pix
{
    "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: Transações TED
{
    "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: Transações de pagamento de boleto bancário
{
    "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: Transações de Liquidação de Cartão
{
    "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: Transações de Compra no Cartão
{
    "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
    }
}
Atenção!

O campo product_type contido no objeto transaction_details das Transações de Liquidação de Cartão de Crédito, é um campo informado pelo Sistema de Liquidações de Cartão, e pode ser retornado com valor null. Para estes casos, o campo product_description deve ser lido para identificação do product_type da liquidação.

Enumeradores product_type​

EnumeradorDescrição
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

Enumeradores de source_sub_types’s:​

EnumDescrição
operation_disbursementDesembolso da Operação
protest_expenseDespesas de Protesto
automatic_integrated_paymentPagamento Automático Integrado
taxImpostos
electronic_funds_feeTarifa de TED
credit_operation_feeTarifa de Abertura de Crédito
internal_funds_transferTransferência Interna
incoming_funds_transferTransferência de Entrada
outgoing_funds_transferTED
depositDepósito
withdrawalTransferência
withdrawal_reversalEstorno de Transferência
trade_funds_transferTransferência de Pagamento de Cessão
settlement_funds_transferTransferência para Liquidação
bank_slip_feeTarifa de Boleto
bank_slip_settlementLiquidação de Boleto
outgoing_funds_transfer_reversalEstorno de TED
incoming_funds_transfer_refusalTransferência Negada
electronic_funds_fee_reversalEstorno de Tarifa de TED
monthly_account_fee_reversalEstorno de Tarifa de Manutenção de Conta
bank_slip_fee_reversalEstorno de Tarifa de Boleto
correspondent_bank_transferRepasse de Correspondente Bancário
credit_analysis_feeTarifa de Análise de Crédito
credit_operation_fee_reversalEstorno de Tarifa de Abertura de Crédito
financial_investments_incomeRenda de Aplicação Financeira
bank_slip_settlement_reversalEstorno de Liquidação de Boleto
bank_slip_settlement_expense_reversalEstorno de Tarifa de liquidação de Boleto
bank_slip_settlement_incoming_reversalEstorno de Recebimento de Liquidação de Boleto
correspondent_bank_transfer_reversalEstrono de Repasse de Correspondente Bancário
credit_analysis_fee_reversalEstorno de Tarifa de Análise de Crédito
doc_expense_reversalEstorno de Tarifa de DOC
incoming_doc_reversalEstorno de Entrada de DOC
operation_disbursement_reversalEstorno de Desembolso da Operação
operation_settling_reversalEstorno de Pagamento de Operação
outgoing_doc_reversalEstorno de Saída de DOC
rebate_reversalEstorno de Rebate
settlement_funds_transfer_reversalEstorno de Transferência para Liquidação
tax_reversalEstorno de Impostos
trade_funds_transfer_reversalEstorno de Transferência de Pagamento de Cessão
bank_slip_permanency_feeTarifa de Permanência do Título
bank_slip_cancel_protest_feeTarifa de Permanência do Título
bank_slip_protest_feeTarifa de Pedido de Protesto
bank_slip_notary_office_feeCustas de Protesto
bank_slip_registration_feeTarifa de Registro
bank_slip_extension_feeTarifa de Prorrogação
bank_slip_rebate_feeTarifa de Abatimento
bank_slip_discount_feeTarifa de Desconto
bank_slip_settlement_feeTarifa de Liquidação
bank_slip_write_off_term_feeTarifa de Baixa por Decurso de Prazo
bank_slip_write_off_feeTarifa de Baixa
bank_slip_cancel_protest_write_off_feeTarifa de Sustação de Protesto com Baixa
bank_slip_notary_office_settlement_feeTarifa de Liquidação em Cartório
rebate_tax_freeRepasse por Conta e Ordem
rebate_tax_free_reversalEstorno de Repasse por Conta e Ordem
incoming_funds_transfer_reversalEstorno de Transferência Interna
bank_slip_paymentPagamento de Boleto
bank_slip_payment_reversalEstorno de Pagamento de Boleto
warranty_analysis_feeTarifa de Análise de Garantia
bank_slip_settlement_depositLiquidação de Boleto
bank_slip_payment_withdrawalPagamento de Boleto
account_setup_feeTarifa de Abertura de Conta
account_setup_fee_reversalEstorno de Tarifa de Abertura de Conta
bank_slip_payment_withdrawal_reversalEstorno de Pagamento de Boleto
incoming_anticipation_of_receivable-
incoming_credit_card_settlementLiquidação de cartão de crédito
incoming_debit_card_settlementLiquidação de cartão de débito
assignment_automatic_transferDébito de Cessão Automática
assignment_automatic_transfer_reversalEstorno de Débito de Cessão Automática
pix_feeTarifa de PIX
incoming_pix_transferEntrada de PIX
outgoing_pix_transferSaída de PIX
pix_fee_reversalEstorno de Tarifa de PIX
incoming_pix_transfer_reversalEstorno de entrada de PIX
outgoing_pix_transfer_reversalEstorno de saída de PIX
pix_depositDepósito de PIX
pix_withdrawalTransferência de PIX
pix_withdrawal_reversalEstorno de transferência de PIX
pix_chargeback_withdrawalEnvio de devolução PIX
outgoing_pix_chargebackSaída de PIX por devolução
incoming_pix_chargebackRecebimento de devolução PIX
pix_chargeback_depositEntrada de PIX por devolução
pix_chargeback_withdrawal_reversalEstorno de envio de devolução PIX
outgoing_pix_chargeback_reversalEstorno de saída de PIX por devolução
incoming_pix_chargeback_reversalEstorno de recebimento de devolução PIX
operation_pix_disbursementDesembolso PIX da Operação
operation_pix_disbursement_reversalEstorno de Desembolso PIX da Operação
receivables_inquiry_feeTarifa de Consulta de Agenda de Recebíveis
pix_deposit_reversalEstorno de Depósito de PIX
internal_pix_transferTransferência de PIX
automatic_integrated_payment_reversalEstorno de Pagamento Automático Integrado
operation_dibursement_reversalEstorno de Desembolso da Operação
available_yieldDepósito de Investimento Liquido
bank_slip_convenant_paymentPagamento de Boleto de Convênio

Enumeradores de prepaid_card_transaction_type:​

EnumDescrição
purchaseCompra no cartão
international_purchaseCompra internacional no cartão
withdrawalSaque em caixa eletrônico (ATM) no cartão

Enumeradores de card_type:​

EnumDescrição
plasticCartão físico
virtualCartão virtual