Skip to main content

List PIX Statement Data By Product

GET 
/v1/reports/pix-statement-product
Tag: api-baas-get-all-report-pix-statement-productDescription: Retrieve a list of PIX statement data filtered by product. When filtering by date, ensure that the date range is within the same month. If no date has been specified in the filters, the statement will be generated for the current month. When using filters, both filter_type and filter_text must be provided together.

Request​

Query Parameters

    filter_type string

    Possible values: [beneficiary_document, owner_document, end_to_end_id, merchant_id, txid]

    Filter Type:

    • beneficiary_document: Beneficiary Document.
    • owner_document: Owner Document.
    • end_to_end_id: End To End ID.
    • merchant_id: Merchant ID.
    • txid: Tx ID.

    filter_text string

    Filter text.

    page_state string

    Previous page state.

    created_at_start date-time

    Created at start.

    created_at_end date-time

    Created at end.

Header Parameters

    x-wallet-uuid string

    Sender Wallet UUID (if empty, your default Wallet UUID will be settled)

    nonce stringrequired

    The nonce ID is a UUID (v4) used to uniquely identify the request. All requests must have an identifier.

    x-lang string

    Possible values: [pt-BR, en-US]

    Indicates the preferred language. Defaults to Brazilian Portuguese if unspecified.

    x-product-uuid stringrequired

    UUID (v4) of the product that the request should use. Send it explicitly when the authenticated user has more than one product or when the integration must select a specific product. If omitted and the endpoint does not require it, the API uses the authenticated user's default product.

    x-product-target-user-uuid string

    UUID (v4) of the user on whose behalf the request should run within the selected product. If omitted, the request runs as the authenticated user. Requires x-product-uuid.

Responses​

The PIX statement data returned successfully.

Schema
    data object[]required

    Pix statement data.

  • Array [
    • beneficiary_bank_name string

    Payment beneficiary bank name.

    beneficiary_branch string

    Payment beneficiary branch (bank agency).

    beneficiary_document string

    Payment beneficiary document (cpf or cnpj).

    beneficiary_name string

    Payment beneficiary name.

    beneficiary_person_type string

    Possible values: [NATURAL_PERSON, LEGAL_PERSON]

    Payment beneficiary person type.

    beneficiary_account_number string

    Payment beneficiary account number.

    beneficiary_account_type string

    Payment beneficiary account type.

    beneficiary_bank_ispb string

    Payment beneficiary bank ispb.

    product_id stringrequired

    Product ID.

    description string

    Payment description.

    end_to_end_id string

    Payment end to end id.

    key string

    Payment key.

    operation_type stringrequired

    Possible values: [C, D]

    Operations type.

    owner_account_number string

    Payment owner account number.

    owner_branch string

    Payment owner branch.

    owner_document string

    Payment owner document (cpf or cnpj).

    owner_full_name string

    Payment owner full name.

    owner_person_type string

    Possible values: [NATURAL_PERSON, LEGAL_PERSON]

    Payment owner person type.

    payment_confirmed_at date-time

    Payment confirmed at.

    payment_canceled_at date-time

    Payment canceled at.

    payment_date date-time

    Payment date.

    payment_type string

    Possible values: [ACCOUNT, KEY, QR_CODE, QR_CODE_STATIC_INSTANT, QR_CODE_STATIC_WITHDRAWAL, QR_CODE_DYNAMIC_DUE_DATE, QR_CODE_DYNAMIC_WITHDRAWAL, QR_CODE_DYNAMIC_CHANGE, QR_CODE_DYNAMIC_INSTANT, AUTOMATIC_PAYMENT]

    Payment type.

    state stringrequired

    Possible values: [PENDING, PENDING_GATEWAY, SCHEDULED, WAITING, WAITING_INTERNAL, WAITING_DELAYED, CONFIRMED, FAILED, CANCELED, ANTIFRAUD_ANALYSIS, ANTIFRAUD_ANALYSIS_REVIEW]

    Payment state.

    operation_created_at date-timerequired

    Operation created at.

    transaction_id stringrequired

    Transaction ID.

    transaction_type_tag stringrequired

    Possible values: [P2PBT, WITHDRAW, PIXCHANGE, PIXDEVREC, PIXDEVSEND, PIXREC, PIXREFUND, PIXREFUNDDEV, PIXSEND, PIXSENDAUTOMATIC, PIXSENDSELF, TED, CONV, BTCSEND, BTCRECEIVE, BBP, BBD, DEPORECEIVE, TEDRECEIVE, DEBITTRANSACTION, DEBITCBK, TEDFAILURE, TEDUNDO, TEDRECCBK, DEPRECCBK, DOCRECEIVE, PIXRECEIVE, WITHDRAWCBK, CASHBACK, CASHBACKCBK, FORFEITURE, DBTCARDCRED, ACTCLOSURE, REFREWARD, EXTRACREDIT, SALECREDCARD, SALEDEBTCARD, PIXWITHDRAWAL, ADMCRYPTOSEND, ADMCRYPTOREC, P2PBTCTP, P2PBTCTC, P2PTP, P2PTC, CBK, P2MTP, SP, TEDTRANSFERSELF, TEDDEVREC, PIXSENDRESTRICTED, CASHREC, BANKTRANSFERREC, BANKTRANSFERSEND_ARG, BANKTRANSFERDEV_ARG, BANKTRANSFERSEND_CHL, BANKTRANSFERDEV_CHL, BANKTRANSFERSEND_PER, BANKTRANSFERDEV_PER, DEBITCARDREC, CREDITCARDREC, CREDITDEBITCARDREC, YAPEWALLETREC, YAPEWALLETDEV, QRREC]

    Operation transaction type tag.

    transaction_updated_at date-time

    Transaction updated at.

    txid string

    Payment tx Id.

    merchant_id string

    Merchant ID.

    value numberrequired

    Payment value.

  • ]
    • has_next_page booleanrequired

    Has next page.

    page_state string

    Page state.

Loading...