GET
/
v1
/
transactions
/
{transactionId}
Retrieve transaction status
curl --request GET \
  --url http://localhost:4011/v1/transactions/{transactionId} \
  --header 'Authorization: Bearer <token>'
{
  "transactionId": "TXN-ABC-123",
  "externalId": "EXT-XYZ-456",
  "endToEndId": "E12345678202501011200000001",
  "txId": "TXN-ABC-123",
  "transactionAt": "2024-01-15T10:30:00.000Z",
  "executedAt": "2024-01-15T10:30:05.000Z",
  "status": -1,
  "amount": 10,
  "description": "Internal transfer between accounts",
  "payer": {
    "bankId": "12345678",
    "document": "11122233344",
    "name": "John Doe",
    "branch": "0001",
    "accountType": 0,
    "accountNumber": "123456",
    "accountDigit": "0",
    "key": "11122233344"
  },
  "payee": {
    "bankId": "12345678",
    "document": "12345678901",
    "name": "João da Silva",
    "branch": "0001",
    "accountType": 0,
    "bankAccountType": 0,
    "accountNumber": "123456",
    "accountDigit": "0",
    "key": "12345678901",
    "bankName": "Banco Example"
  }
}

Authorizations

​
Authorization
string
header
required

JWT token obtained from the authentication endpoint

Path Parameters

​
transactionId
string
required

Transaction ID to retrieve status for

Response

Transaction status retrieved successfully

​
transactionId
string

Transaction identifier

Example:

"TXN-ABC-123"

​
externalId
string

External reference identifier

Example:

"EXT-XYZ-456"

​
endToEndId
string

End-to-end identifier

Example:

"E12345678202501011200000001"

​
txId
string

Transaction identifier

Example:

"TXN-ABC-123"

​
transactionAt
string<date-time>

Transaction timestamp

Example:

"2024-01-15T10:30:00.000Z"

​
executedAt
string<date-time>

Execution timestamp

Example:

"2024-01-15T10:30:05.000Z"

​
status
enum<integer>

Transaction status enumeration (-1 - PROCESSING_ERROR, 0- PROCESSING, 1- PENDING_CONFIRM, 2- EXECUTED, 3- FAILED, 4- REVERSAL, 5- REPROVED, 6- SCHEDULE, 7- CANCELLED).

Available options:
-1,
0,
1,
2,
3,
4,
5,
8,
9
​
amount
number

Transaction amount

Example:

10

​
description
string

Transaction description

Example:

"Internal transfer between accounts"

​
payer
object
​
payee
object