Pular para o conteúdo principal
GET
/
v1
/
transactions
/
{transactionId}
Consultar status da transacao
curl --request GET \
  --url https://plugin-br-pix-direct-jd.sandbox.lerian.net/v1/transactions/{transactionId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "txn_123456789",
  "jdpiRequestId": "req_abc123xyz",
  "endToEndId": "E1234567820230615123456789012345",
  "status": "EXECUTED",
  "payer": {
    "bankId": "12345678",
    "document": "12345678901",
    "name": "João da Silva",
    "branch": "0001",
    "accountType": 0,
    "accountNumber": "123456",
    "accountDigit": "7",
    "accountId": "01989f9e-6508-79f8-9540-835be49fbd0d",
    "bankAccountType": 0,
    "key": "+5511987654321",
    "keyType": 3
  },
  "payee": {
    "bankId": "12345678",
    "document": "12345678901",
    "name": "João da Silva",
    "branch": "0001",
    "accountType": 0,
    "accountNumber": "123456",
    "accountDigit": "7",
    "accountId": "01989f9e-6508-79f8-9540-835be49fbd0d",
    "bankAccountType": 0,
    "key": "+5511987654321",
    "keyType": 3
  },
  "amount": 100.5,
  "description": "Payment for services"
}

Autorizações

​
Authorization
string
header
obrigatório

Autenticacao por token JWT Bearer. Obtenha o token no endpoint /v1/login/oauth/access_token usando credenciais do cliente (clientId e clientSecret).

Inclua o token no header Authorization: Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

O token expira apos 3600 segundos (1 hora).

Parâmetros de caminho

​
transactionId
string
obrigatório

Identificador da transacao.

Resposta

Detalhes da transacao recuperados com sucesso

​
id
string
obrigatório

Identificador unico da transacao.

Exemplo:

"txn_123456789"

​
jdpiRequestId
string
obrigatório

Identificador da requisicao JDPI.

Exemplo:

"req_abc123xyz"

​
endToEndId
string
obrigatório

Identificador de transacao ponta a ponta.

Exemplo:

"E1234567820230615123456789012345"

​
status
enum<string>
obrigatório

Status de processamento da transacao. Valores string indicando o estado atual de uma transacao PIX.

Valores validos:

  • PENDING = Transacao foi iniciada e aguarda processamento pelo sistema de pagamentos
  • PENDING_CONFIRM = Transacao aguarda confirmacao final
  • EXECUTED = Transacao concluida com sucesso e fundos transferidos
  • REVERSAL = Transacao foi revertida (estornada)
  • REPROVED = Transacao foi rejeitada ou falhou na validacao
  • SCHEDULE = Transacao agendada para execucao futura
  • CANCELLED = Transacao foi cancelada pelo usuario antes da execucao
  • ERROR = Ocorreu um erro de processamento durante a execucao da transacao
Opções disponíveis:
PENDING,
PENDING_CONFIRM,
EXECUTED,
REVERSAL,
REPROVED,
SCHEDULE,
CANCELLED,
ERROR
Exemplo:

"EXECUTED"

​
payer
object
obrigatório

Informacoes da conta bancaria.

​
payee
object
obrigatório

Informacoes da conta bancaria.

​
amount
number<double>
obrigatório

Valor da transacao.

Exemplo:

100.5

​
description
string
obrigatório

Descricao da transacao.

Exemplo:

"Payment for services"