Skip to main content
GET
https://api.pronttus.com.br
/
v1
/
banking
/
transactions
/
{transactionId}
curl -X GET https://api.pronttus.com.br/v1/banking/transactions/637b1c49-b7e7-40ac-8cba-7f1fbf5cd32c \
  -H "Authorization: Bearer seu_token"
{
  "statusCode": 200,
  "message": "Transação encontrada com sucesso",
  "data": {
    "id": "637b1c49-b7e7-40ac-8cba-7f1fbf5cd222",
    "status": "COMPLETED",
    "end_to_end_id": "E3030629420251021001900000043Kcp",
    "payer": {
      "name": "João Almeida",
      "document": "12345678910",
      "ispb": "30306294",
      "account_number": "1206552",
      "account_type": "0"
    }
  }
}

Visão Geral

Este endpoint permite consultar o status e os detalhes de uma transação específica, incluindo informações sobre pagamentos, saques e transferências. O endpoint retorna diferentes informações dependendo do status e tipo da transação.
Use este endpoint para verificar o status de transações criadas anteriormente, seja para recebimentos (PIX) ou saques/transferências.

Autenticação

Authorization
string
required
Token Bearer obtido no endpoint de autenticação Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6Ikp...

Parâmetros da URL

transactionId
string
required
UUID único da transação que deseja consultar
curl -X GET https://api.pronttus.com.br/v1/banking/transactions/637b1c49-b7e7-40ac-8cba-7f1fbf5cd32c \
  -H "Authorization: Bearer seu_token"
{
  "statusCode": 200,
  "message": "Transação encontrada com sucesso",
  "data": {
    "id": "637b1c49-b7e7-40ac-8cba-7f1fbf5cd222",
    "status": "COMPLETED",
    "end_to_end_id": "E3030629420251021001900000043Kcp",
    "payer": {
      "name": "João Almeida",
      "document": "12345678910",
      "ispb": "30306294",
      "account_number": "1206552",
      "account_type": "0"
    }
  }
}

Campos da Resposta

statusCode
integer
Código de status HTTP da resposta (200)
message
string
Mensagem de sucesso da operação
data
object
Dados da transação consultada
data.id
string
UUID único da transação
data.status
string
Status da transação. Valores possíveis: - COMPLETED: Transação concluída com sucesso - WAITING_PAYMENT: Aguardando pagamento (para recebimentos) - FAILED: Transação falhou - PROCESSING: Transação em processamento
data.end_to_end_id
string
ID fim-a-fim do PIX (identificador único do Banco Central). Presente apenas quando status é COMPLETED e a transação foi processada com sucesso.
data.payer
object
Dados do pagador. Presente apenas em transações de recebimento (COMPLETED).
data.receiver
object
Dados do recebedor. Presente apenas em transações de saque/transferência (COMPLETED).
data.error
object
Detalhes do erro. Presente apenas quando status é FAILED.

Status da Transação

COMPLETED

Transação concluída com sucesso. Para recebimentos, inclui dados do payer. Para saques/transferências, inclui dados do receiver e end_to_end_id.

WAITING_PAYMENT

Transação de recebimento aguardando pagamento. Apenas o id e status são retornados.

FAILED

Transação falhou. Inclui objeto error com detalhes sobre o problema.

PROCESSING

Transação em processamento. Geralmente ocorre em saques/transferências que ainda estão sendo processados.
Recomendação: Configure webhooks para receber notificações automáticas sobre mudanças de status, evitando a necessidade de consultar constantemente o status da transação.