Sign in

v1

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

Get transaction from provider

Get Pix transaction from the provider given its type and end-to-end-ID in the path. Can be used to verify that both provider and Pismo have the same information.

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

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

Path parameters

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

Pix transaction type

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

OK

amountnumber double

Fee amount.

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.

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

Example response

{
  "amount": 215,
  "end_to_end_id": "E3030629420200808195101608910248",
  "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"
  },
  "status": "PROCESSING"
}