Skip to main content
GET
/
v1
/
query
/
get-transaction
Get single transaction
curl --request GET \
  --url https://api.example.com/v1/query/get-transaction \
  --header 'X-Pubkey: <x-pubkey>' \
  --header 'X-Pubkey, X-Timestamp, X-Signature: <api-key>' \
  --header 'X-Signature: <x-signature>' \
  --header 'X-Timestamp: <x-timestamp>'
{
  "transactionId": "550e8400-e29b-41d4-a716-446655440000",
  "accountId": "550e8400-e29b-41d4-a716-446655440000",
  "chainId": 123,
  "vaultAddr": "<string>",
  "onchainTxAmount": "123.456789",
  "type": "deposit",
  "status": "completed",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "fiatAccountId": "550e8400-e29b-41d4-a716-446655440000",
  "transactionHash": "<string>",
  "optId": "<string>",
  "broadcastedAt": "2023-11-07T05:31:56Z",
  "sourceCurrency": "usd",
  "destinationCurrency": "usd",
  "fiatTransactionId": "<string>",
  "destinationAmount": "123.456789",
  "sourceAmount": "123.456789",
  "relatedTransactionId": "550e8400-e29b-41d4-a716-446655440000",
  "fiat_deposit_instructions": {
    "currency": "usd",
    "bankName": "Lead Bank",
    "bankAddress": "1801 Main St., Kansas City, MO 64108",
    "paymentRails": [
      "achPush"
    ],
    "bankBeneficiaryName": "John Smith",
    "bankBeneficiaryAddress": "1234 Main St., Kansas City, MO 64108",
    "expectedDepositAmount": "123.456789",
    "bankAccountNumber": "1234567890",
    "bankRoutingNumber": "87654321",
    "iban": "FR12345678901234567890",
    "bic": "BICFR12345"
  },
  "destination_bank_account": {
    "country": "FRA",
    "last4": "0804",
    "bic": "BICFR12345"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.byzantine.fi/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-Pubkey, X-Timestamp, X-Signature
string
header
required

Headers

​
X-Pubkey
string
required

Integrator's ECDSA public key (P-256 curve, compressed SEC1 format). Example: 0x038fedef7c12f93bbf342ad8943b7a825a3b41f61c9dc118b2c718efebabbf62fd

​
X-Timestamp
string
required

Unix timestamp in seconds (UTC). Must be within tolerance window (1 minute) to prevent replay attacks. Example: 1760375826

​
X-Signature
string
required

ECDSA signature (DER-encoded, hex with 0x prefix). Signs the message: {timestamp}{METHOD}{path_and_query}{json_body}. Example: 0x3045022100...

Query Parameters

​
transaction_id
string<uuid>
required

A UUID string

Example:

"550e8400-e29b-41d4-a716-446655440000"

Response

Transaction retrieved successfully

Response for getting a single transaction by ID

​
transactionId
string<uuid>
required

A UUID string

Example:

"550e8400-e29b-41d4-a716-446655440000"

​
accountId
string<uuid>
required

A UUID string

Example:

"550e8400-e29b-41d4-a716-446655440000"

​
chainId
integer<int32>
required
​
vaultAddr
string
required
​
onchainTxAmount
string
required

A high-precision decimal number represented as a string

Example:

"123.456789"

​
type
enum<string>
required

Type of transaction that is being submitted.

Available options:
authorization,
approve,
approve_deposit,
deposit,
withdraw,
transfer,
withdraw_transfer
Example:

"deposit"

​
status
enum<string>
required

The current status of the transaction.

Available options:
created,
waiting_for_funds,
funds_in_transfer,
processing,
completed,
simulation_failed,
reverted
Example:

"completed"

​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
fiatAccountId
string<uuid>

A UUID string

Example:

"550e8400-e29b-41d4-a716-446655440000"

​
transactionHash
string | null
​
optId
string | null
​
broadcastedAt
string<date-time> | null
​
sourceCurrency
enum<string>
Available options:
usd,
eur,
usdc,
eurc
​
destinationCurrency
enum<string>
Available options:
usd,
eur,
usdc,
eurc
​
fiatTransactionId
string | null
​
destinationAmount
string

A high-precision decimal number represented as a string

Example:

"123.456789"

​
sourceAmount
string

A high-precision decimal number represented as a string

Example:

"123.456789"

​
relatedTransactionId
string<uuid>

A UUID string

Example:

"550e8400-e29b-41d4-a716-446655440000"

​
fiat_deposit_instructions
object
​
destination_bank_account
object

Bank account details where the funds will be transferred to (withdrawals only).