Get a Transaction by ID

Error

A valid request URL is required to generate request examples

{
  "amount": "1500",
  "assetCode": "BRL",
  "createdAt": "2021-01-01T00:00:00Z",
  "credit": [
    "@person2"
  ],
  "debit": [
    "@person1"
  ],
  "deletedAt": "2021-01-01T00:00:00Z",
  "description": "Transaction description",
  "feesSkipped": false,
  "id": "00000000-0000-0000-0000-000000000000",
  "ledgerId": "00000000-0000-0000-0000-000000000000",
  "operations": [
    {
      "accountAlias": "@person1",
      "accountId": "00000000-0000-0000-0000-000000000000",
      "amount": {
        "value": "1500"
      },
      "assetCode": "BRL",
      "balance": {
        "available": "1500",
        "onHold": "500",
        "overdraftUsed": "130",
        "version": 2
      },
      "balanceAffected": true,
      "balanceAfter": {
        "available": "1500",
        "onHold": "500",
        "overdraftUsed": "130",
        "version": 2
      },
      "balanceId": "00000000-0000-0000-0000-000000000000",
      "balanceKey": "asset-freeze",
      "createdAt": "2021-01-01T00:00:00Z",
      "deletedAt": "2021-01-01T00:00:00Z",
      "description": "Credit card operation",
      "id": "00000000-0000-0000-0000-000000000000",
      "ledgerId": "00000000-0000-0000-0000-000000000000",
      "metadata": {},
      "organizationId": "00000000-0000-0000-0000-000000000000",
      "status": {
        "code": "ACTIVE",
        "description": "Active status"
      },
      "transactionId": "00000000-0000-0000-0000-000000000000",
      "type": "DEBIT",
      "updatedAt": "2021-01-01T00:00:00Z",
      "direction": "debit",
      "routeCode": "ROUTE-001",
      "routeDescription": "Settlement route for service charges",
      "routeId": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "organizationId": "00000000-0000-0000-0000-000000000000",
  "status": {
    "code": "ACTIVE",
    "description": "Active status"
  },
  "tracerSkipped": false,
  "updatedAt": "2021-01-01T00:00:00Z",
  "metadata": {},
  "parentTransactionId": "00000000-0000-0000-0000-000000000000",
  "routeId": "00000000-0000-0000-0000-000000000000"
}

{
  "code": "ERR-0001",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

GET

organizations

{organization_id}

ledgers

{ledger_id}

transactions

{transaction_id}

Error

A valid request URL is required to generate request examples

{
  "amount": "1500",
  "assetCode": "BRL",
  "createdAt": "2021-01-01T00:00:00Z",
  "credit": [
    "@person2"
  ],
  "debit": [
    "@person1"
  ],
  "deletedAt": "2021-01-01T00:00:00Z",
  "description": "Transaction description",
  "feesSkipped": false,
  "id": "00000000-0000-0000-0000-000000000000",
  "ledgerId": "00000000-0000-0000-0000-000000000000",
  "operations": [
    {
      "accountAlias": "@person1",
      "accountId": "00000000-0000-0000-0000-000000000000",
      "amount": {
        "value": "1500"
      },
      "assetCode": "BRL",
      "balance": {
        "available": "1500",
        "onHold": "500",
        "overdraftUsed": "130",
        "version": 2
      },
      "balanceAffected": true,
      "balanceAfter": {
        "available": "1500",
        "onHold": "500",
        "overdraftUsed": "130",
        "version": 2
      },
      "balanceId": "00000000-0000-0000-0000-000000000000",
      "balanceKey": "asset-freeze",
      "createdAt": "2021-01-01T00:00:00Z",
      "deletedAt": "2021-01-01T00:00:00Z",
      "description": "Credit card operation",
      "id": "00000000-0000-0000-0000-000000000000",
      "ledgerId": "00000000-0000-0000-0000-000000000000",
      "metadata": {},
      "organizationId": "00000000-0000-0000-0000-000000000000",
      "status": {
        "code": "ACTIVE",
        "description": "Active status"
      },
      "transactionId": "00000000-0000-0000-0000-000000000000",
      "type": "DEBIT",
      "updatedAt": "2021-01-01T00:00:00Z",
      "direction": "debit",
      "routeCode": "ROUTE-001",
      "routeDescription": "Settlement route for service charges",
      "routeId": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "organizationId": "00000000-0000-0000-0000-000000000000",
  "status": {
    "code": "ACTIVE",
    "description": "Active status"
  },
  "tracerSkipped": false,
  "updatedAt": "2021-01-01T00:00:00Z",
  "metadata": {},
  "parentTransactionId": "00000000-0000-0000-0000-000000000000",
  "routeId": "00000000-0000-0000-0000-000000000000"
}

{
  "code": "ERR-0001",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Authorizations

Authorization

string

header

required

JWT bearer token issued by the identity provider.

Path Parameters

organization_id

string

required

Organization ID (UUID)

ledger_id

string

required

Ledger ID (UUID)

transaction_id

string

required

Transaction ID (UUID)

Response

amount

string | null

required

Example:

"1500"

assetCode

string

required

Required string length: 2 - 10

Example:

"BRL"

createdAt

string<date-time>

required

Example:

"2021-01-01T00:00:00Z"

credit

string[] | null

required

Example:

["@person2"]

debit

string[] | null

required

Example:

["@person1"]

deletedAt

string<date-time> | null

required

Example:

"2021-01-01T00:00:00Z"

description

string

required

Maximum string length: 256

Example:

"Transaction description"

feesSkipped

boolean

required

Example:

false

string<uuid>

required

Example:

"00000000-0000-0000-0000-000000000000"

ledgerId

string<uuid>

required

Example:

"00000000-0000-0000-0000-000000000000"

operations

object[] | null

required

Show child attributes

organizationId

string<uuid>

required

Example:

"00000000-0000-0000-0000-000000000000"

status

object

required

Show child attributes

tracerSkipped

boolean

required

Example:

false

updatedAt

string<date-time>

required

Example:

"2021-01-01T00:00:00Z"

metadata

object

Show child attributes

parentTransactionId

string<uuid>

Example:

"00000000-0000-0000-0000-000000000000"

routeId

string<uuid>

Example:

"00000000-0000-0000-0000-000000000000"

Getting started

Current (v2)

Compatibility (v1)

Error handling

Get a Transaction by ID

Authorizations

Path Parameters

Response