v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB

Pix

List account receipts

Retrieve account's receipts with filter options. The account is parsed from the account authorization token.

get/pix/v1/pix/receipts

Query parameters

perPageinteger

Example:15

Items per page

begin_datestring required

Example:2025-01-01

Beginning date filter, format = yyyy-mm-dd

end_datestring required

Example:2025-01-30

End date filter, format = yyyy-mm-dd

type'PIX_IN' | 'PIX_OUT' | 'PIX_IN_REVERSAL' | 'PIX_OUT_REVERSAL'

Pix transaction type filter

endToEndIdstring required

Transaction end-to-end ID filter. This field is a Brazil Central Bank (BCB) requirement to track all Pix transaction steps.

reversalEndToEndIdstring

Reversal end-to-end ID filter.

order'ASC' | 'DESC'

Order to return items: ASC = ascending order, DESC = descending. Default is DESC.

afterIdstring

Last returned item ID from response. Use this field to return more results.

Headers

Authorizationstring required

Example:Bearer eyJhbGci...IUzUx

Account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a <b>401 Unauthorized</b> message.

Response

Response Body

last_idinteger

Last returned item ID. Use this ID to get more results.

next_pageboolean

Are tbere more results?

per_pageinteger

Maximum number of items per page

Example response

{
  "items": [
    {
      "amount": 215,
      "purchase_amount": 1050.44,
      "withdraw_amount": 100,
      "transaction_identification": "d4c38871c8354f0fbe91b3c9c7d5b929",
      "type": "PIX-IN",
      "authorization_datetime": "2021-10-11T19:01:43.392Z",
      "charges": {
        "discount_value": 0.15,
        "interest_value": 20.15,
        "fine_value": 5.15,
        "settled_value": 10.15
      },
      "debtor": {
        "document_number": "7777888hh",
        "name": "Paul Bearer"
      },
      "description": "Transaction Pix",
      "end_to_end_id": "E3030629420200808195101608910248",
      "initial_amount": "10.02",
      "initiation_type": "DICT",
      "transaction_type": "TRANSFER",
      "initiator_document_number": "7777888hh",
      "payee": {
        "account_number": "98765432",
        "branch": "011",
        "document_number": "7777888hh",
        "ispb": "60701190",
        "name": "Paul Bearer"
      },
      "payer": {
        "account_number": "98765432",
        "branch": "011",
        "document_number": "7777888hh",
        "ispb": "60701190",
        "name": "Paul Bearer"
      },
      "qrcode_additional_information": [
        {
          "name": "Discount",
          "value": "Paying until the 5th, there will be a 10% discount"
        }
      ],
      "reversal": {
        "amount": 215,
        "authorization_datetime": "2021-10-11T19:01:43.392Z",
        "end_to_end_id": "E3030629420200808195101608910248",
        "reason": "USER_REQUESTED"
      },
      "tx_id": "d4c38871c8354f0fbe91b3c9c7d5b929",
      "taxes": {
        "tax_identifier": "IS0435879820240605bcdb1fhn43a",
        "records": [
          {
            "tax_type": "IBS",
            "amount": 1050.44
          }
        ]
      }
    }
  ],
  "last_id": 1602619,
  "per_page": 15
}