Pular para o conteúdo principal
GET
/
v1
/
transactions
Listar transacoes
curl --request GET \
  --url https://plugin-br-pix-direct-jd.sandbox.lerian.net/v1/transactions \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "txn_123456789",
    "accountId": "acc_123",
    "endToEndId": "E1234567820230615123456789012345",
    "status": "EXECUTED",
    "amount": 100.5,
    "description": "Payment",
    "flow": 1,
    "type": 1,
    "payer": {
      "name": "Maria Santos",
      "document": "98765432100"
    },
    "payee": {
      "name": "João Silva",
      "document": "12345678901"
    },
    "createdAt": "2023-06-15T10:30:00Z",
    "updatedAt": "2023-06-15T10:30:05Z"
  }
]

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 consulta

​
account_id
string<uuid>

Filtrar transacoes por UUID de conta especifico.

​
end_to_end_id
string

Filtrar por identificador unico de transacao ponta a ponta (E2E ID).

​
type
enum<integer>

Filtrar por tipo de transacao. Use valor numerico: 1=PIX.

Identificador do tipo de transacao. Codigo numerico especificando o tipo de transacao de pagamento.

Valores validos:

  • 1 = PIX (Pagamento instantaneo via sistema PIX brasileiro)
Opções disponíveis:
1
Exemplo:

1

​
status
enum<string>

Filtrar por status da transacao. Valores possiveis: PENDING, PENDING_CONFIRM, EXECUTED, REVERSAL, REPROVED, SCHEDULE, CANCELLED, ERROR.

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"

​
is_refund
boolean

Filtrar transacoes de estorno.

​
is_internal
boolean

Filtrar transacoes internas.

​
created_at
string<date>

Filtrar por data de criacao.

​
updated_at
string<date>

Filtrar por data de atualizacao.

Resposta

Lista de transacoes recuperada com sucesso

​
id
string
obrigatório

Identificador unico da transacao.

Exemplo:

"txn_123456789"

​
accountId
string
obrigatório

Identificador da conta associada a transacao.

Exemplo:

"acc_123"

​
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"

​
amount
number<double>
obrigatório

Valor da transacao.

Exemplo:

100.5

​
description
string
obrigatório

Descricao da transacao.

Exemplo:

"Payment"

​
flow
enum<integer>
obrigatório

Direcao do fluxo da transacao. Codigo numerico indicando se o dinheiro esta entrando, saindo ou sendo transferido internamente.

Valores validos:

  • 1 = CASH_IN (Recebimento de pagamento - dinheiro entrando na conta)
  • 2 = CASH_OUT (Envio de pagamento - dinheiro saindo da conta)
  • 3 = INTRA_PSP (Transferencia interna dentro do mesmo Prestador de Servicos de Pagamento)
Opções disponíveis:
1,
2,
3
Exemplo:

1

​
type
enum<integer>
obrigatório

Identificador do tipo de transacao. Codigo numerico especificando o tipo de transacao de pagamento.

Valores validos:

  • 1 = PIX (Pagamento instantaneo via sistema PIX brasileiro)
Opções disponíveis:
1
Exemplo:

1

​
payer
object
obrigatório
​
payee
object
obrigatório
​
createdAt
string<date-time>
obrigatório

Data e hora de criacao da transacao.

Exemplo:

"2023-06-15T10:30:00Z"

​
updatedAt
string<date-time>
obrigatório

Data e hora da ultima atualizacao da transacao.

Exemplo:

"2023-06-15T10:30:05Z"