Skip to main content
GET
/
v1
/
transactions
/
{transactionId}
Retrieve transaction status
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"
}

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).

Path Parameters

​
transactionId
string
required

Transaction identifier.

Response

Transaction details retrieved successfully

​
id
string
required

Unique transaction identifier.

Example:

"txn_123456789"

​
jdpiRequestId
string
required

JDPI request identifier.

Example:

"req_abc123xyz"

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

​
payer
object
required

Bank account information.

​
payee
object
required

Bank account information.

​
amount
number<double>
required

Transaction amount.

Example:

100.5

​
description
string
required

Transaction description.

Example:

"Payment for services"