---
updatedAt: 2026-05-04T19:18:29.000Z
agentTools:
siteIndex: https://developers.pismo.io/llms.txt
projectIndex: https://developers.pismo.io/pismo-docs/llms.txt
---
# 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.
# OpenAPI definition
```json
{
"openapi": "3.1.0",
"info": {
"title": "Instant payments - Pix payments",
"description": "API to handle Pix transactions",
"contact": {
"name": "API Support",
"url": "https://developers.pismo.io/support/"
},
"license": {
"name": "Copyright Pismo"
},
"version": "1.0"
},
"servers": [
{
"url": "https://sandbox-cdn.pismolabs.io",
"description": "Sandbox API server for testing"
},
{
"url": "https://sandbox-cdn.pismolabs.io/inst-pull-pay",
"description": "Sandbox API server for testing instant pull pay."
}
],
"tags": [
{
"name": "Pix"
}
],
"components": {
"parameters": {
"AuthHeader": {
"in": "header",
"name": "Authorization",
"required": true,
"description": "Account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a 401 Unauthorized message.",
"schema": {
"type": "string",
"example": "Bearer eyJhbGci...IUzUx"
}
},
"EndToEndIDpath": {
"name": "end_to_end_id",
"in": "path",
"description": "Transaction end-to-end ID. This field is a Brazil Central Bank (BCB) requirement to track all Pix transaction steps.",
"required": true,
"schema": {
"type": "string"
}
},
"TransactionTypePath": {
"name": "type",
"in": "path",
"description": "Pix transaction type",
"schema": {
"type": "string",
"enum": [
"PIX-IN",
"PIX-OUT",
"PIX-IN-REVERSAL",
"PIX-OUT-REVERSAL"
]
},
"required": true,
"example": "PIX-IN"
}
},
"schemas": {
"AccountNumber": {
"type": "string",
"description": "Account number.",
"maxLength": 20,
"example": "98765432"
},
"AccountType": {
"type": "string",
"enum": [
"CACC",
"SLRY",
"SVGS",
"TRAN"
],
"maxLength": 4,
"description": "Account type:
\n `CACC` - Checking/current account. Known as \"conta corrente\" in Portuguese, this is a bank account type designed for everyday financial transactions and is the most common type individuals and businesses use for day-to-day banking.
\n `SVGS` - Savings account
\n `TRAN` - Payment account. Payment institutions offer payment accounts to move funds and make payments, while banks offer checking accounts that include full financial services such as credit and investments.
\n `SLRY` - Salary account. Employer deposits a fixed amount every month.
\n",
"example": "TRAN"
},
"Amount": {
"type": "number",
"description": "Amount to be transferred.",
"example": 1050.44
},
"Branch": {
"type": "string",
"description": "This could be a bank-assigned branch ID or the branch's ISPB number.",
"maxLength": 4,
"example": "011"
},
"customer.DetailMessage": {
"type": "object",
"properties": {
"external": {
"type": "array",
"items": {
"$ref": "#/components/schemas/customer.ExternalMessage"
}
},
"parameters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/customer.ParameterMessage"
}
},
"payload": {
"type": "array",
"items": {
"$ref": "#/components/schemas/customer.PayloadMessage"
}
}
}
},
"customer.Error": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Error's code.",
"example": "EPT0001"
},
"details": {
"$ref": "#/components/schemas/customer.DetailMessage"
},
"message": {
"type": "string",
"description": "Error's message.",
"example": "User not found"
}
}
},
"customer.ExternalMessage": {
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string",
"description": "Error code.",
"example": "PBE315"
},
"message": {
"type": "string",
"description": "Error message.",
"example": "Generic error"
}
}
},
"customer.ParameterMessage": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string",
"description": "Parameter field",
"example": "Query parameter"
},
"message": {
"type": "string",
"description": "Message about parameter",
"example": "Generic error"
}
}
},
"customer.PayloadMessage": {
"type": "object",
"required": [
"field",
"message"
],
"properties": {
"field": {
"type": "string",
"description": "Payload parameter",
"example": "Entity.field"
},
"message": {
"type": "string",
"description": "Message about error",
"example": "Generic error"
}
}
},
"DocumentNumber": {
"type": "string",
"description": "A government document number, such as a Social Security number (US) or Cadastro de Pessoas Físicas number (Brazil). Must be numeric with 11-14 digits.\n",
"minLength": 1,
"maxLength": 14,
"example": "123412341234"
},
"EndToEndID": {
"type": "string",
"description": "This field is a Brazil Central Bank (BCB) requirement to track all steps of Pix transactions. \nBasically, there are two steps to a Pix transaction:\n 1. Initialize a transaction \n 2. Confirm a transaction\nThe `end_to_end_id` is sent to the BCB in both steps in order to identify all transaction information. \n",
"example": "E3030629420200808195101608910248"
},
"Name": {
"type": "string",
"description": "Name",
"maxLength": 200,
"example": "Walter Melon"
},
"pix.GetTransactionByTypeAndE2EResponse": {
"type": "object",
"properties": {
"amount": {
"$ref": "#/components/schemas/Amount"
},
"end_to_end_id": {
"$ref": "#/components/schemas/EndToEndID"
},
"payee": {
"$ref": "#/components/schemas/pix.TransactionExternalAccount"
},
"payer": {
"$ref": "#/components/schemas/pix.TransactionExternalAccount"
},
"status": {
"$ref": "#/components/schemas/TransactionStatus"
}
}
},
"pix.TransactionExternalAccount": {
"type": "object",
"properties": {
"bank_account": {
"$ref": "#/components/schemas/pix.TransactionExternalBankAccount"
},
"document": {
"$ref": "#/components/schemas/DocumentNumber"
},
"name": {
"$ref": "#/components/schemas/Name"
}
}
},
"pix.TransactionExternalBankAccount": {
"type": "object",
"description": "Bank account details.",
"required": [
"account_number",
"account_type",
"branch"
],
"properties": {
"account_number": {
"$ref": "#/components/schemas/AccountNumber"
},
"account_type": {
"$ref": "#/components/schemas/AccountType"
},
"branch": {
"$ref": "#/components/schemas/Branch"
}
}
},
"TransactionStatus": {
"type": "string",
"description": "Current transaction status:\n\n * `VALIDATED` - Payload was validated and sent to provider\n \n * `PROCESSING` - Waiting response from the provider\n \n * `SETTLED` - Transaction confirmed\n \n * `CANCELLED` - Transaction cancelled\n \n * `ERROR` - Transaction error during processing\n",
"enum": [
"PROCESSING",
"VALIDATED",
"SETTLED",
"CANCELLED",
"ERROR"
],
"example": "PROCESSING"
}
},
"responses": {
"400BadRequest": {
"description": "Bad request",
"headers": {
"x-cid": {
"description": "Request tracking ID.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/customer.Error"
}
}
}
},
"403Forbidden": {
"description": "Forbidden",
"headers": {
"x-cid": {
"description": "Request tracking ID.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/customer.Error"
}
}
}
},
"404NotFound": {
"description": "Not found",
"headers": {
"x-cid": {
"description": "Request tracking ID.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/customer.Error"
}
}
}
},
"500InternalServer": {
"description": "Internal Server Error",
"headers": {
"x-cid": {
"description": "Request tracking ID.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/customer.Error"
}
}
}
}
}
},
"paths": {
"/pix/v1/pix/provider/transaction/type/{type}/end-to-end/{end_to_end_id}": {
"get": {
"summary": "Get transaction from provider",
"description": "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. \n\n**Note:** This endpoint takes an account token - an access token encoded with a Pismo accound ID.\n",
"operationId": "get-pix-transaction",
"tags": [
"Pix"
],
"parameters": [
{
"$ref": "#/components/parameters/AuthHeader"
},
{
"$ref": "#/components/parameters/TransactionTypePath"
},
{
"$ref": "#/components/parameters/EndToEndIDpath"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"x-cid": {
"description": "Request tracking ID.",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/pix.GetTransactionByTypeAndE2EResponse"
}
}
}
},
"400": {
"$ref": "#/components/responses/400BadRequest"
},
"403": {
"$ref": "#/components/responses/403Forbidden"
},
"404": {
"$ref": "#/components/responses/404NotFound"
},
"500": {
"$ref": "#/components/responses/500InternalServer"
}
}
}
}
}
}
```