Skip to main content
GET
/
v1
/
transactions
List transactions
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"
  }
]

Authorizations

​
Authorization
string
header
required

JWT Bearer token authentication. Obtain token from /v1/login/oauth/access_token endpoint using client credentials (clientId and clientSecret).

Include token in Authorization header: Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Token expires after 3600 seconds (1 hour).

Query Parameters

​
account_id
string<uuid>

Filter transactions by specific account UUID.

​
end_to_end_id
string

Filter by unique end-to-end transaction identifier (E2E ID).

​
type
enum<integer>

Filter by transaction type. Use numeric value: 1=PIX.

Available options:
1
Example:

1

​
status
enum<string>

Filter by transaction status. Possible values: PENDING, PENDING_CONFIRM, EXECUTED, REVERSAL, REPROVED, SCHEDULE, CANCELLED, ERROR.

Available options:
PENDING,
PENDING_CONFIRM,
EXECUTED,
REVERSAL,
REPROVED,
SCHEDULE,
CANCELLED,
ERROR
Example:

"EXECUTED"

​
is_refund
boolean

Filter refund transactions.

​
is_internal
boolean

Filter internal transactions.

​
created_at
string<date>

Filter by creation date.

​
updated_at
string<date>

Filter by update date.

Response

List of transactions retrieved successfully

​
id
string
required

Unique transaction identifier.

Example:

"txn_123456789"

​
accountId
string
required

Account identifier associated with the transaction.

Example:

"acc_123"

​
endToEndId
string
required

End-to-end transaction identifier.

Example:

"E1234567820230615123456789012345"

​
status
enum<string>
required

Transaction processing status. String values indicating the current state of a Pix transaction.

Valid values:

  • PENDING = Transaction has been initiated and is awaiting processing by the payment system
  • PENDING_CONFIRM = Transaction is awaiting final confirmation
  • EXECUTED = Transaction successfully completed and funds transferred
  • REVERSAL = Transaction was reversed (refunded)
  • REPROVED = Transaction was rejected or failed validation
  • SCHEDULE = Transaction is scheduled for future execution
  • CANCELLED = Transaction was cancelled by the user before execution
  • ERROR = A processing error occurred during transaction execution
Available options:
PENDING,
PENDING_CONFIRM,
EXECUTED,
REVERSAL,
REPROVED,
SCHEDULE,
CANCELLED,
ERROR
Example:

"EXECUTED"

​
amount
number
required

Transaction amount.

Example:

100.5

​
description
string
required

Transaction description.

Example:

"Payment"

​
flow
enum<integer>
required

Transaction flow direction. Numeric code indicating whether money is coming in, going out, or being transferred internally.

Valid values:

  • 1 = CASH_IN (Receiving payment - money coming into the account)
  • 2 = CASH_OUT (Sending payment - money going out of the account)
  • 3 = INTRA_PSP (Internal transfer within the same Payment Service Provider)
Available options:
1,
2,
3
Example:

1

​
type
enum<integer>
required

Transaction type identifier. Numeric code specifying the type of payment transaction.

Valid values:

  • 1 = PIX (Instant payment via Brazilian Pix system)
Available options:
1
Example:

1

​
payer
object
required
​
payee
object
required
​
createdAt
string<date-time>
required

Transaction creation timestamp.

Example:

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

​
updatedAt
string<date-time>
required

Transaction last update timestamp.

Example:

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