Sign in

v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB
Pix

Get Pix transaction

Retrieve transaction information given an end-to-end value in the path.

Note: This endpoint takes an account token - an access token encoded with a Pismo accound ID.

get/pix/v1/pix/end-to-end/{end_to_end_id}/transaction

Path parameters

end_to_end_idstring required

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

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

end_to_end_idstring

This field is a Brazil Central Bank (BCB) requirement to track all steps of Pix transactions. Basically, there are two steps to a Pix transaction: 1. Initialize a transaction 2. Confirm a transaction The end_to_end_id is sent to the BCB in both steps in order to identify all transaction information.

org_idstring

Organization/tenant ID.

account_idinteger

Account ID

ispbstring

<a href="https://bank.codes/numero-do-banco/bank/banco-central-do-brasil/" target="_blank">ISPB (Identifcador do Sistema de Pagamento Brazil)</a> - the Brazilian Payment System ID, an 8-digit value.

type'PIX-IN' | 'PIX-OUT' | 'PIX-IN-REVERSAL' | 'PIX-OUT-REVERSAL'

Pix transaction type.

transaction_type'TRANSFER' | 'CHANGE' | 'WITHDRAWAL' | 'REFUND_AUTOMATIC_PIX' | 'REFUND'

Type of transaction the QR Code validation generates.

  • TRANSFER - Standard immediate transfer payment.
  • CHANGE - Occurs when the QR Code validation returns CHANGE. For example, the customer buys something and pays more than the product value to receive the difference in cash.
  • WITHDRAWAL - Occurs when the QR Code validation returns WITHDRAWAL with withdrawal object values.
  • REFUND_AUTOMATIC_PIX - Total or partial to the PSP payer user within the Automatic Pix MED (Pix return mechanism) scope (only when initiated by a MANUAL).
  • REFUND = Total or partial refund to the paying user within the scope of MED 2.0, when this refund occurs from the PI Account of the user's PSP who participated in the distribution chain of the resources of the original transaction (only when initiated by a MANUAL)
initiation_type'MANUAL' | 'DICT' | 'STATIC_QRCODE' | 'DYNAMIC_QRCODE' | 'PAYMENT_INITIATOR' | 'AUTOMATIC_PIX' | 'DYNAMIC_PROXIMITY_PIX' | 'STATIC_PROXIMITY_PIX'

Initiation type:

MANUAL - Manually initiated. Key is not used - bank account, bank code, document number, and branch are used for identification.

DICT - Diretorio de Identificadores de Contas de Transacapo (Transaction accounts ID directory). Pix/DICT key is used for identification.

STATIC_QRCODE - Reusable code that contains only the data necessary to complete a transaction. When using static QR Code, the transaction amount must be provided manually.

DYNAMIC_QRCODE - The amount and other details for a dynamic code are included automatically.

PAYMENT_INITIATOR - Payment provider initiated. A payment initiator is a 3rd party that has obtained authorization from the Central Bank and has an <a href="https://www.bcb.gov.br/en/financialstability/open_finance" target="_blank">Open Finance</a> certification.

AUTOMATIC_PIX - Payment order initiated via automatic PIX.

DYNAMIC_PROXIMITY_PIX - Dynamic Near Field Communications (NFC) based initiation.

STATIC_PROXIMITY_PIX - Static NFC-based initiation.

status'PROCESSING' | 'VALIDATED' | 'SETTLED' | 'CANCELLED' | 'ERROR'

Current transaction status:

  • VALIDATED - Payload was validated and sent to provider

  • PROCESSING - Waiting response from the provider

  • SETTLED - Transaction confirmed

  • CANCELLED - Transaction cancelled

  • ERROR - Transaction error during processing

correlation_idstring

Correlation tracking ID (CID)

authorization_idinteger

Generated authorization ID on P2P

client_request_idstring

For Pix-out, this is the client-generated ID used for idempotency. For Pix-in, this is the confirmation request ID the provider received.

initiator_document_numberstring

Payment initiator document number when type is PAYMENT_INITIATOR

initial_amountstring

The initial purchase price amount before charges or withdrawal changes.

amountnumber double

Fee amount.

internalboolean

Was transaction made between a Pismo organization's accounts? In this case, the instant payment system is not called.

additional_descriptionstring

Additional description

transaction_identificationstring

This field is returned from the Validate QR Code endpoint.

Transaction ID is REQUIRED when initiation_type is DYNAMIC_QRCODE and should not be passed otherwise. If a STATIC_QRCODE contains the transaction identification, it is also REQUIRED to pass it.

reason'USER_REQUESTED' | 'FRAUD' | 'BANK_ERROR'

Reversal reason.

external_idstring

Provider external ID

external_movement_idstring

Provider external movement identification

migration_idstring

Transaction migration ID (if migrated).

Example response

{
  "end_to_end_id": "E3030629420200808195101608910248",
  "org_id": "TN-1234...",
  "account_id": 6912345,
  "ispb": "60701190",
  "type": "PIX-IN",
  "transaction_type": "TRANSFER",
  "initiation_type": "DICT",
  "status": "PROCESSING",
  "correlation_id": "8675309",
  "authorization_id": 82725717,
  "client_request_id": "b84da2fc-dd63-4c6c-a346-797b65f334c7",
  "payee": {
    "bank_account": {
      "account_number": "98765432",
      "account_type": "TRAN",
      "branch": "011"
    },
    "document": "7777888hh",
    "name": "Paul Bearer"
  },
  "payer": {
    "bank_account": {
      "account_number": "98765432",
      "account_type": "TRAN",
      "branch": "011"
    },
    "document": "7777888hh",
    "name": "Paul Bearer"
  },
  "initiator_document_number": "12345678900",
  "initial_amount": "10.02",
  "amount": 215,
  "additional_description": "Charge #1",
  "qr_code_additional_information": [
    {
      "name": "Discount",
      "value": "Paying until the 5th, there will be a 10% discount"
    }
  ],
  "transaction_identification": "1a84daf6-a61b-4aba-919a-a9943db7102e",
  "reason": "USER_REQUESTED",
  "external_id": "1236723",
  "external_movement_id": "12345678",
  "migration_id": "c80118a7-7cef-4378-a3be-e0e28efbf150",
  "charges": {
    "discount_value": 0.15,
    "fine_value": 5.15,
    "interest_value": 20.15
  },
  "dates": {
    "created_datetime": "2021-10-11T19:01:43.392Z",
    "psp_transaction_created_at": "2021-10-12T19:01:43.392Z",
    "received_datetime": "2021-10-12T19:01:43.392Z",
    "updated_datetime": "2021-10-12T19:01:43.392Z"
  },
  "taxes": {
    "tax_identifier": "IS0435879820240605bcdb1fhn43a",
    "records": [
      {
        "tax_type": "IBS",
        "amount": 1050.44
      }
    ]
  }
}