Retrieve a Transaction

Request example

{
  "path": {
    "transactionId": "transaction_123"
  }
}

# Sample only. Generate a new signed token for each request
# (see Authentication). Tokens expire after 120 seconds.
curl --request GET \
  --url "https://api.primevault.com/api/external/transactions/transaction_123/" \
  --header "Authorization: Bearer <signed JWT>" \
  --header "Api-Key: <API key>" \
  --header "Accept: application/json"

Response example

{
  "id": "transaction_123",
  "orgId": "org_456",
  "vaultId": "vault_123",
  "status": "COMPLETED",
  "transactionType": "OUTGOING",
  "category": "TRANSFER",
  "subCategory": "EXTERNAL_TRANSFER",
  "createdAt": "2026-08-04T10:40:00Z",
  "updatedAt": "2026-08-04T10:42:15Z",
  "isDeleted": false,
  "externalId": "invoice-1001",
  "memo": "Vendor payout #1001",
  "source": {
    "type": "VAULT",
    "id": "vault_123",
    "subOrgId": "sub_org_123",
    "name": "Treasury Vault"
  },
  "destination": {
    "type": "CONTACT",
    "id": "contact_456",
    "name": "Operations Wallet",
    "address": "0xAbC1234567890abcdef1234567890abcdef1234",
    "chain": "ETHEREUM"
  },
  "blockChain": "ETHEREUM",
  "asset": "ETH",
  "amount": "0.50",
  "txHash": "0x9f4e6c1b7a2d3e4f",
  "balanceChanges": {
    "changes": [
      {
        "party": {
          "type": "VAULT",
          "id": "vault_123",
          "subOrgId": "sub_org_123",
          "name": "Treasury Vault"
        },
        "asset": "ETH",
        "amount": "-0.50",
        "chain": "ETHEREUM"
      },
      {
        "party": {
          "type": "CONTACT",
          "id": "contact_456",
          "name": "Operations Wallet",
          "address": "0xAbC1234567890abcdef1234567890abcdef1234",
          "chain": "ETHEREUM"
        },
        "asset": "ETH",
        "amount": "0.50",
        "chain": "ETHEREUM"
      }
    ]
  }
}

interface Transaction {
  id: string;
  orgId: string;
  vaultId: string;
  status: TransactionStatus | string;
  transactionType: TransactionType | string;
  category: TransactionCategory | string;
  subCategory: TransactionSubCategory | string;
  createdAt: string;
  updatedAt: string;
  isDeleted: boolean;
  amount: string;

  txHash?: string;
  error?: string;
  externalId?: string;
  createdById?: string;
  fees?: Fees;
  memo?: string;
  txnSignature?: string;
  txnSignatureData?: Record<string, unknown>;
  output?: TransactionOutput;
  amountInUSD?: string;
  nonce?: number;
  dAppId?: string;
  source?: TransferPartyData;
  destination?: TransferPartyData;
  quoteResponse?: QuoteResponseItem;
  depositInstructions?: DepositInstructions;
  operations?: TransactionOperation[];
  balanceChanges?: TransactionOperationBalanceChanges | null;
  blockChain?: string;
  asset?: string;

  /** Deprecated: use destination.address. */
  toAddress?: string;
  /** Deprecated: use destination.name. */
  toAddressName?: string;
  /** Deprecated: use destination.id. */
  toVaultId?: string;
  /** Deprecated: use source.address. */
  sourceAddress?: string;
}

GET /api/external/transactions/{transactionId}/

Path parameter

string

required

ID returned by a transaction create or list response.

Response

Returns the Transaction. Its status is the lifecycle source of truth.

string

Transaction ID. Use it with Retrieve Transaction to track status.

string

Organization that owns the transaction.

string

Vault the transaction runs from.

string

Lifecycle status. Track it until COMPLETED, FAILED, or DECLINED. See TransactionStatus.

string

See TransactionType.

string

For example TRANSFER or CONTRACT_CALL. See TransactionCategory.

string

See TransactionSubCategory.

string

Creation timestamp (ISO 8601).

string

Last update timestamp (ISO 8601).

boolean

Whether the transaction is deleted.

string

Your own reference, if you set one.

string

Memo you attached, if any.

TransferPartyData

Where the funds come from. Which fields are present depends on type. See TransferPartyData.

Show Properties

string

VAULT, BANK_ACCOUNT, CONTACT, EXTERNAL_ADDRESS, or EXTERNAL_BANK_ACCOUNT.

string

ID of the vault, bank account, or contact.

string

Display name.

string

Wallet address, for crypto parties.

string

Blockchain, for crypto parties.

string

Payment rail, for bank parties, such as ACH.

TransferPartyData

Where the funds go. Same fields as source. See TransferPartyData.

Show Properties

string

VAULT, BANK_ACCOUNT, CONTACT, EXTERNAL_ADDRESS, or EXTERNAL_BANK_ACCOUNT.

string

ID of the vault, bank account, or contact.

string

Display name.

string

Wallet address, for crypto parties.

string

Blockchain, for crypto parties.

string

Payment rail, for bank parties, such as ACH.

string

Chain the transaction runs on.

string

Asset moved.

string

Amount as a decimal string.

string

On-chain transaction hash, once broadcast.

Fees

Fees charged. See Fees.

string

Failure reason, if the transaction failed.

TransactionOperationBalanceChanges | null

Aggregate balance movements across the transaction, when present: the input asset debited and the output asset credited. See TransactionOperationBalanceChanges.

Show Properties

TransactionOperationBalanceChange[]

One entry per party and asset. See TransactionOperationBalanceChange.

Show Properties

TransferPartyData | null

Party whose balance changed. Same fields as source. See TransferPartyData.

string

Asset symbol.

string

Signed decimal string: negative for a debit, positive for a credit.

string

Blockchain, for crypto movements.

string

Payment rail, for fiat movements.

QuoteResponseItem

The executed quote, including its input, output, source, destination, and expiresAt. See QuoteResponseItem.

DepositInstructions

Present when funding is required. Use the returned details exactly. See DepositInstructions.

Request example

{
  "path": {
    "transactionId": "transaction_123"
  }
}

# Sample only. Generate a new signed token for each request
# (see Authentication). Tokens expire after 120 seconds.
curl --request GET \
  --url "https://api.primevault.com/api/external/transactions/transaction_123/" \
  --header "Authorization: Bearer <signed JWT>" \
  --header "Api-Key: <API key>" \
  --header "Accept: application/json"

Response example

{
  "id": "transaction_123",
  "orgId": "org_456",
  "vaultId": "vault_123",
  "status": "COMPLETED",
  "transactionType": "OUTGOING",
  "category": "TRANSFER",
  "subCategory": "EXTERNAL_TRANSFER",
  "createdAt": "2026-08-04T10:40:00Z",
  "updatedAt": "2026-08-04T10:42:15Z",
  "isDeleted": false,
  "externalId": "invoice-1001",
  "memo": "Vendor payout #1001",
  "source": {
    "type": "VAULT",
    "id": "vault_123",
    "subOrgId": "sub_org_123",
    "name": "Treasury Vault"
  },
  "destination": {
    "type": "CONTACT",
    "id": "contact_456",
    "name": "Operations Wallet",
    "address": "0xAbC1234567890abcdef1234567890abcdef1234",
    "chain": "ETHEREUM"
  },
  "blockChain": "ETHEREUM",
  "asset": "ETH",
  "amount": "0.50",
  "txHash": "0x9f4e6c1b7a2d3e4f",
  "balanceChanges": {
    "changes": [
      {
        "party": {
          "type": "VAULT",
          "id": "vault_123",
          "subOrgId": "sub_org_123",
          "name": "Treasury Vault"
        },
        "asset": "ETH",
        "amount": "-0.50",
        "chain": "ETHEREUM"
      },
      {
        "party": {
          "type": "CONTACT",
          "id": "contact_456",
          "name": "Operations Wallet",
          "address": "0xAbC1234567890abcdef1234567890abcdef1234",
          "chain": "ETHEREUM"
        },
        "asset": "ETH",
        "amount": "0.50",
        "chain": "ETHEREUM"
      }
    ]
  }
}

interface Transaction {
  id: string;
  orgId: string;
  vaultId: string;
  status: TransactionStatus | string;
  transactionType: TransactionType | string;
  category: TransactionCategory | string;
  subCategory: TransactionSubCategory | string;
  createdAt: string;
  updatedAt: string;
  isDeleted: boolean;
  amount: string;

  txHash?: string;
  error?: string;
  externalId?: string;
  createdById?: string;
  fees?: Fees;
  memo?: string;
  txnSignature?: string;
  txnSignatureData?: Record<string, unknown>;
  output?: TransactionOutput;
  amountInUSD?: string;
  nonce?: number;
  dAppId?: string;
  source?: TransferPartyData;
  destination?: TransferPartyData;
  quoteResponse?: QuoteResponseItem;
  depositInstructions?: DepositInstructions;
  operations?: TransactionOperation[];
  balanceChanges?: TransactionOperationBalanceChanges | null;
  blockChain?: string;
  asset?: string;

  /** Deprecated: use destination.address. */
  toAddress?: string;
  /** Deprecated: use destination.name. */
  toAddressName?: string;
  /** Deprecated: use destination.id. */
  toVaultId?: string;
  /** Deprecated: use source.address. */
  sourceAddress?: string;
}

⌘I

Request example

{
  "path": {
    "transactionId": "transaction_123"
  }
}

# Sample only. Generate a new signed token for each request
# (see Authentication). Tokens expire after 120 seconds.
curl --request GET \
  --url "https://api.primevault.com/api/external/transactions/transaction_123/" \
  --header "Authorization: Bearer <signed JWT>" \
  --header "Api-Key: <API key>" \
  --header "Accept: application/json"

Response example

{
  "id": "transaction_123",
  "orgId": "org_456",
  "vaultId": "vault_123",
  "status": "COMPLETED",
  "transactionType": "OUTGOING",
  "category": "TRANSFER",
  "subCategory": "EXTERNAL_TRANSFER",
  "createdAt": "2026-08-04T10:40:00Z",
  "updatedAt": "2026-08-04T10:42:15Z",
  "isDeleted": false,
  "externalId": "invoice-1001",
  "memo": "Vendor payout #1001",
  "source": {
    "type": "VAULT",
    "id": "vault_123",
    "subOrgId": "sub_org_123",
    "name": "Treasury Vault"
  },
  "destination": {
    "type": "CONTACT",
    "id": "contact_456",
    "name": "Operations Wallet",
    "address": "0xAbC1234567890abcdef1234567890abcdef1234",
    "chain": "ETHEREUM"
  },
  "blockChain": "ETHEREUM",
  "asset": "ETH",
  "amount": "0.50",
  "txHash": "0x9f4e6c1b7a2d3e4f",
  "balanceChanges": {
    "changes": [
      {
        "party": {
          "type": "VAULT",
          "id": "vault_123",
          "subOrgId": "sub_org_123",
          "name": "Treasury Vault"
        },
        "asset": "ETH",
        "amount": "-0.50",
        "chain": "ETHEREUM"
      },
      {
        "party": {
          "type": "CONTACT",
          "id": "contact_456",
          "name": "Operations Wallet",
          "address": "0xAbC1234567890abcdef1234567890abcdef1234",
          "chain": "ETHEREUM"
        },
        "asset": "ETH",
        "amount": "0.50",
        "chain": "ETHEREUM"
      }
    ]
  }
}

interface Transaction {
  id: string;
  orgId: string;
  vaultId: string;
  status: TransactionStatus | string;
  transactionType: TransactionType | string;
  category: TransactionCategory | string;
  subCategory: TransactionSubCategory | string;
  createdAt: string;
  updatedAt: string;
  isDeleted: boolean;
  amount: string;

  txHash?: string;
  error?: string;
  externalId?: string;
  createdById?: string;
  fees?: Fees;
  memo?: string;
  txnSignature?: string;
  txnSignatureData?: Record<string, unknown>;
  output?: TransactionOutput;
  amountInUSD?: string;
  nonce?: number;
  dAppId?: string;
  source?: TransferPartyData;
  destination?: TransferPartyData;
  quoteResponse?: QuoteResponseItem;
  depositInstructions?: DepositInstructions;
  operations?: TransactionOperation[];
  balanceChanges?: TransactionOperationBalanceChanges | null;
  blockChain?: string;
  asset?: string;

  /** Deprecated: use destination.address. */
  toAddress?: string;
  /** Deprecated: use destination.name. */
  toAddressName?: string;
  /** Deprecated: use destination.id. */
  toVaultId?: string;
  /** Deprecated: use source.address. */
  sourceAddress?: string;
}

API Basics

Approvals

Accounts

Sub-Orgs

Transactions

Retrieve a Transaction

Path parameter

Response

​Path parameter

​Response

Path parameter

Response