Get transaction by ID

curl --request GET \
  --url https://sandbox-api.polygon.technology/v0.11/transactions/{transactionId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://sandbox-api.polygon.technology/v0.11/transactions/{transactionId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://sandbox-api.polygon.technology/v0.11/transactions/{transactionId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox-api.polygon.technology/v0.11/transactions/{transactionId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox-api.polygon.technology/v0.11/transactions/{transactionId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://sandbox-api.polygon.technology/v0.11/transactions/{transactionId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "txn_mmbdyjd3r0z92y1zwck56anv0r",
  "object": "transaction",
  "sourceToDestination": "cryptoToCrypto",
  "status": "failed",
  "subStatus": "failed.returnComplete",
  "customerId": "cst_vfa0nxw6zvyws9g237jrxn4y7k",
  "precursor": {
    "type": "quote",
    "details": {
      "quoteId": "qt_6yd7gwfxaa13m83sepnzrmqnj2"
    }
  },
  "source": {
    "party": {
      "relationship": "customer",
      "customerId": "cst_vfa0nxw6zvyws9g237jrxn4y7k",
      "entityType": "individual"
    },
    "type": "walletOms",
    "category": "crypto",
    "details": {
      "id": "wlt_5h4jzzpr9xre3bamd9ca7qyghn",
      "asset": "usdc",
      "network": "polygon",
      "blockchainAddress": "0x7B3A9F2C4D1eA8bf6390cE5D2b7fA104c8e3D9B1",
      "txHash": "0x8a3b7c1d2e3f4a5b6c7d8e9f0a1b2c3d4e5f6a7b",
      "custodyType": "custodial"
    }
  },
  "destination": {
    "party": {
      "relationship": "externalRegistered",
      "counterpartyId": "ctp_yp5z8m7n22svc0vh6edqgcfdat",
      "entityType": "individual",
      "name": "Alice Smith",
      "address": {
        "line1": "500 Market St",
        "city": "San Francisco",
        "state": "CA",
        "country": "US",
        "zipCode": "94105"
      }
    },
    "type": "walletExternal",
    "category": "crypto",
    "details": {
      "id": "ext_95863ktcdhw27ze8hxgybb24n9",
      "asset": "usdc",
      "network": "base",
      "blockchainAddress": "0xbEeF4A2C891d56e72B67a3f21d0cF94f1D7c5911",
      "custodian": "COINBASE_US"
    },
    "payoutOrigin": {
      "type": "blockchain",
      "blockchainAddress": "0x7B3A9F2C4D1eA8bf6390cE5D2b7fA104c8e3D9B1",
      "network": "base"
    }
  },
  "pricing": {
    "source": {
      "asset": "usdc",
      "amountGross": "100.00",
      "amountNet": "100.00",
      "feesDeducted": {
        "total": "0.00",
        "developer": "0.00",
        "oms": "0.00",
        "gas": "0.00"
      }
    },
    "destination": {
      "asset": "usdc",
      "amountGross": "100.00",
      "amountNet": "100.00",
      "feesDeducted": {
        "total": "0.00",
        "developer": "0.00",
        "oms": "0.00",
        "gas": "0.00"
      }
    },
    "pair": "usdc/usdc",
    "exchangeRate": "1.0000",
    "effectiveRate": "1.0000",
    "fixedAmountSide": "source",
    "sponsorGas": true,
    "sponsorGasCost": "0.00"
  },
  "error": {
    "code": "bridgeTimeout",
    "message": "Bridge transaction timed out after 30 minutes.",
    "occurredAt": "2026-03-14T19:35:00Z",
    "recoverable": false
  },
  "createdAt": "2026-03-14T19:00:00Z",
  "updatedAt": "2026-03-14T19:35:00Z"
}

GET

transactions

{transactionId}

Get transaction by ID

curl --request GET \
  --url https://sandbox-api.polygon.technology/v0.11/transactions/{transactionId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://sandbox-api.polygon.technology/v0.11/transactions/{transactionId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://sandbox-api.polygon.technology/v0.11/transactions/{transactionId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox-api.polygon.technology/v0.11/transactions/{transactionId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox-api.polygon.technology/v0.11/transactions/{transactionId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://sandbox-api.polygon.technology/v0.11/transactions/{transactionId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "txn_mmbdyjd3r0z92y1zwck56anv0r",
  "object": "transaction",
  "sourceToDestination": "cryptoToCrypto",
  "status": "failed",
  "subStatus": "failed.returnComplete",
  "customerId": "cst_vfa0nxw6zvyws9g237jrxn4y7k",
  "precursor": {
    "type": "quote",
    "details": {
      "quoteId": "qt_6yd7gwfxaa13m83sepnzrmqnj2"
    }
  },
  "source": {
    "party": {
      "relationship": "customer",
      "customerId": "cst_vfa0nxw6zvyws9g237jrxn4y7k",
      "entityType": "individual"
    },
    "type": "walletOms",
    "category": "crypto",
    "details": {
      "id": "wlt_5h4jzzpr9xre3bamd9ca7qyghn",
      "asset": "usdc",
      "network": "polygon",
      "blockchainAddress": "0x7B3A9F2C4D1eA8bf6390cE5D2b7fA104c8e3D9B1",
      "txHash": "0x8a3b7c1d2e3f4a5b6c7d8e9f0a1b2c3d4e5f6a7b",
      "custodyType": "custodial"
    }
  },
  "destination": {
    "party": {
      "relationship": "externalRegistered",
      "counterpartyId": "ctp_yp5z8m7n22svc0vh6edqgcfdat",
      "entityType": "individual",
      "name": "Alice Smith",
      "address": {
        "line1": "500 Market St",
        "city": "San Francisco",
        "state": "CA",
        "country": "US",
        "zipCode": "94105"
      }
    },
    "type": "walletExternal",
    "category": "crypto",
    "details": {
      "id": "ext_95863ktcdhw27ze8hxgybb24n9",
      "asset": "usdc",
      "network": "base",
      "blockchainAddress": "0xbEeF4A2C891d56e72B67a3f21d0cF94f1D7c5911",
      "custodian": "COINBASE_US"
    },
    "payoutOrigin": {
      "type": "blockchain",
      "blockchainAddress": "0x7B3A9F2C4D1eA8bf6390cE5D2b7fA104c8e3D9B1",
      "network": "base"
    }
  },
  "pricing": {
    "source": {
      "asset": "usdc",
      "amountGross": "100.00",
      "amountNet": "100.00",
      "feesDeducted": {
        "total": "0.00",
        "developer": "0.00",
        "oms": "0.00",
        "gas": "0.00"
      }
    },
    "destination": {
      "asset": "usdc",
      "amountGross": "100.00",
      "amountNet": "100.00",
      "feesDeducted": {
        "total": "0.00",
        "developer": "0.00",
        "oms": "0.00",
        "gas": "0.00"
      }
    },
    "pair": "usdc/usdc",
    "exchangeRate": "1.0000",
    "effectiveRate": "1.0000",
    "fixedAmountSide": "source",
    "sponsorGas": true,
    "sponsorGasCost": "0.00"
  },
  "error": {
    "code": "bridgeTimeout",
    "message": "Bridge transaction timed out after 30 minutes.",
    "occurredAt": "2026-03-14T19:35:00Z",
    "recoverable": false
  },
  "createdAt": "2026-03-14T19:00:00Z",
  "updatedAt": "2026-03-14T19:35:00Z"
}

Authorizations

Authorization

string

header

required

Token from POST /auth/token

Path Parameters

transactionId

string

required

Transaction ID (txn_ prefix).

Response

200 - application/json

The request has succeeded.

A single movement of money from a source to a destination. Created by accepting a quote, or generated automatically by a deposit address, virtual account, or cash-in. Track its progress with status.

string

required

Transaction ID (txn_ prefix).

Pattern: ^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$

object

enum<string>

required

Resource type discriminator. Always "transaction".

Available options:

transaction

status

enum<string>

required

Current lifecycle status. See subStatus for finer granularity.

Available options:

processing,

awaitingAction,

completed,

failed

customerId

string

required

The owning (sender) customer. OMSX customer TypeID (cst_…).

Pattern: ^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$

precursor

Deposit address · object

required

What created this transaction, carrying that origin's deposit instructions. Always present: the manual arm covers any transaction with no automated origin.

Deposit address
Virtual account
Cash-in
Quote
Manual

Hide child attributes

precursor.type

enum<string>

required

Type discriminator.

Available options:

depositAddress

precursor.details

object

required

depositAddress origin payload: the DA id + its on-chain inlet instructions.

Hide child attributes

precursor.details.depositAddressId

string

required

Deposit Address ID (da_ prefix).

Pattern: ^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$

precursor.details.depositInstructions

object

The on-chain address senders deposit to, with its asset and network.

Hide child attributes

precursor.details.depositInstructions.asset

string

required

Same value as expectedSourceAsset.

precursor.details.depositInstructions.network

string

required

Same value as expectedSourceNetwork.

precursor.details.depositInstructions.address

string

required

Erebor-owned on-chain inlet address for this DA.

precursor.details.depositInstructions.expiresAt

string<date-time>

Placeholder for a future provider-imposed inlet expiry. Null for Erebor DDAs today; surfaced now so adding it later is not a breaking change.

source

OMS wallet · object

required

The funding side: a typed instrument carrying identity and detail.

Hide child attributes

source.type

enum<string>

required

Type discriminator.

Available options:

walletOms

source.category

enum<string>

required

High-level grouping: fiatAccount for bank or card accounts, crypto for wallets.

Available options:

crypto

source.details

object

required

WalletOms instrument details: an OMS-custodied crypto wallet.

Hide child attributes

source.details.id

string

Internal OMS wallet (wlt_ prefix; legacy acc_ also accepted on input).

Pattern: ^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$

source.details.asset

string

Canonical asset identifier.

source.details.network

string

Network identifier.

source.details.blockchainAddress

string

On-chain address.

source.details.custodyType

enum<string>

How the wallet is held: custodial or embedded.

Available options:

custodial,

embedded

source.details.txHash

string

On-chain transaction hash.

source.details.blockchainAsset

object

BPN extension: resolved on-chain asset identity (protocol/chainId/tokenId).

Hide child attributes

source.details.blockchainAsset.protocol

enum<string>

required

Available options:

evm,

svm,

sui

source.details.blockchainAsset.chainId

string

required

source.details.blockchainAsset.tokenId

string

required

source.party

Customer · object

Structured identity of who is on this side.

Customer
Another customer
Registered external account
Unregistered external account

Hide child attributes

source.party.relationship

enum<string>

required

Relationship discriminator.

Available options:

customer

source.party.customerId

string

required

The OMS customer that owns this record (cst_ prefix).

Pattern: ^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$

source.party.entityType

enum<string>

Available options:

individual,

business

destination

OMS wallet · object

required

The receiving side: a typed instrument plus payoutOrigin.

Hide child attributes

destination.type

enum<string>

required

Type discriminator.

Available options:

walletOms

destination.category

enum<string>

required

High-level grouping: fiatAccount for bank or card accounts, crypto for wallets.

Available options:

crypto

destination.details

object

required

WalletOms instrument details: an OMS-custodied crypto wallet.

Hide child attributes

destination.details.id

string

Internal OMS wallet (wlt_ prefix; legacy acc_ also accepted on input).

Pattern: ^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$

destination.details.asset

string

Canonical asset identifier.

destination.details.network

string

Network identifier.

destination.details.blockchainAddress

string

On-chain address.

destination.details.custodyType

enum<string>

How the wallet is held: custodial or embedded.

Available options:

custodial,

embedded

destination.details.txHash

string

On-chain transaction hash.

destination.details.blockchainAsset

object

BPN extension: resolved on-chain asset identity (protocol/chainId/tokenId).

Hide child attributes

destination.details.blockchainAsset.protocol

enum<string>

required

Available options:

evm,

svm,

sui

destination.details.blockchainAsset.chainId

string

required

destination.details.blockchainAsset.tokenId

string

required

destination.party

Customer · object

Structured identity of who is on this side.

Customer
Another customer
Registered external account
Unregistered external account

Hide child attributes

destination.party.relationship

enum<string>

required

Relationship discriminator.

Available options:

customer

destination.party.customerId

string

required

The OMS customer that owns this record (cst_ prefix).

Pattern: ^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$

destination.party.entityType

enum<string>

Available options:

individual,

business

destination.payoutOrigin

Bank · object

Payout originates from a bank account. v0.10 wraps the fields in a details envelope (matches the precursor shape). accountNumber/routingNumber are full sending-account detail rendered on the Transaction only, null on Quote/Deposit Address (choice-only).

Bank
Blockchain

Hide child attributes

destination.payoutOrigin.type

enum<string>

required

Type discriminator.

Available options:

bank

destination.payoutOrigin.details

object

required

Bank payout-origin detail. accountHolder(+Name) is the chosen sender identity (echoed on Quote/DA too); accountNumber/routingNumber are the full sending-account coordinates (Transaction only, else null); virtualAccountId is the VA the funds were pulled from.

Hide child attributes

destination.payoutOrigin.details.accountHolder

enum<string>

Who holds the payout bank account (OMS closed enum). customer is the only valid value.

Available options:

customer

destination.payoutOrigin.details.accountHolderName

string

Name of the sending account holder.

destination.payoutOrigin.details.accountNumber

string | null

Bank account number.

destination.payoutOrigin.details.routingNumber

string | null

US ABA routing number.

destination.payoutOrigin.details.virtualAccountId

string | null

Virtual Account ID (va_ prefix).

Pattern: ^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$

pricing

object

required

Consolidated economics.

Hide child attributes

pricing.source

object

Economics for the source side, denominated in the source asset.

Hide child attributes

pricing.source.asset

string

Currency these amounts are in. Same as the side's instrument asset, repeated here so pricing is self-contained.

pricing.source.amountGross

string

Amount on this side before fees are applied.

pricing.source.amountNet

string

Amount after fees: what is actually pulled from a source, or delivered to a destination.

pricing.source.feesDeducted

object

Itemized fees deducted on this side.

Hide child attributes

pricing.source.feesDeducted.total

string

required

pricing.source.feesDeducted.developer

string

required

Per-side aggregated developer fee total in this side's asset. Always "0" in alpha - alpha invariant, mirrors the gas line.

pricing.source.feesDeducted.oms

string

required

pricing.source.feesDeducted.gas

string

required

pricing.destination

object

Economics for the destination side, denominated in the destination asset.

Hide child attributes

pricing.destination.asset

string

Currency these amounts are in. Same as the side's instrument asset, repeated here so pricing is self-contained.

pricing.destination.amountGross

string

Amount on this side before fees are applied.

pricing.destination.amountNet

string

Amount after fees: what is actually pulled from a source, or delivered to a destination.

pricing.destination.feesDeducted

object

Itemized fees deducted on this side.

Hide child attributes

pricing.destination.feesDeducted.total

string

required

pricing.destination.feesDeducted.developer

string

required

Per-side aggregated developer fee total in this side's asset. Always "0" in alpha - alpha invariant, mirrors the gas line.

pricing.destination.feesDeducted.oms

string

required

pricing.destination.feesDeducted.gas

string

required

pricing.pair

string

Asset pair, e.g. "usdc/usd".

pricing.exchangeRate

string

Mid-market rate between source and destination assets. Identity: source.amountNet × exchangeRate = destination.amountGross.

pricing.effectiveRate

string

All-in rate including all fees. Identity: source.amountGross × effectiveRate = destination.amountNet.

pricing.fixedAmountSide

enum<string>

The side you set amount on when creating the quote. OMS calculated the other side.

Available options:

source,

destination

When true, OMS absorbs the destination gas cost. Currently always true.

Gas absorbed by the developer when sponsorGas is true. Currently always 0.00.

sourceToDestination

enum<string>

Corridor composite derived from the two sides.

Available options:

cryptoToCrypto,

cryptoToCash,

cryptoToFiatAccount,

cashToCrypto,

fiatAccountToCrypto,

fiatAccountToFiatAccount

subStatus

enum<string>

Status-scoped sub-state (e.g. processing.fundsPulled). Absent when the transaction has no meaningful sub-state.

Available options:

processing.fundsPulled,

processing.cashPickupReady,

processing.underReview,

completed.cashPickupCollected,

completed.cashPickupExpired,

awaitingAction.awaitingSenderAttribution,

awaitingAction.depositAddressFrozen,

awaitingAction.depositAddressInactive,

failed.attributionTimeout,

failed.depositAddressFrozenTimeout,

failed.depositAddressInactiveTimeout,

failed.depositAddressClosed,

processing.awaitingCryptoOut,

processing.cryptoOut,

processing.awaitingFiatOut,

processing.fiatOut,

processing.inboundPending,

processing.inboundProcessing,

failed.inboundFailed,

failed.returnPending,

failed.returnStarted,

failed.returnComplete,

failed.returnFailed

estimatedArrival

string<date-time>

Estimated completion time. Present when the destination rail has a predictable settlement time (e.g. bank payouts and some crypto legs); null otherwise.

error

object

Failure detail. Set when the transaction fails; includes refund or recovery state where applicable.

Hide child attributes

error.code

string

required

Machine-readable code.

error.message

string

required

Human-readable detail.

error.occurredAt

string<date-time>

required

When the error occurred.

error.recoverable

boolean

required

Whether the failure can be recovered.

error.manualRecovery

object

Populated only for terminal failures with no resolved refund/return path (v0.11).

Hide child attributes

error.manualRecovery.type

enum<string>

Available options:

manualRecovery

error.manualRecovery.custodian

enum<string>

Available options:

ANCHORAGE_SG,

ANCHORAGE_US,

AQUANOW_CA,

B2C2_UK,

B2C2_US,

BITGO_SG,

BITGO_US,

BITSTAMP_US,

BVNK_US,

CIRCLE_FR,

CIRCLE_US,

CITIBANK_US,

COINBASE_US,

COINSMART_CA,

COPPER_CH,

COPPER_UK,

CUMBERLAND_DRW_LLC_US,

CUMBERLAND_SG,

EREBOR_BANK_US,

FALCONX_US,

FIDELITY_UK,

FIDELITY_US,

FIREBLOCKS_APAC,

FIREBLOCKS_US,

GALAXY_KY,

GEMINI_US,

KRAKEN_BVI,

KRAKEN_EU_IE,

KRAKEN_UK,

KRAKEN_US,

NUBANK_BR,

PAXOS_US,

RAMP_NETWORK_US,

ROBINHOOD_US,

WINTERMUTE_GB,

SELF_HOSTED,

OTHER

error.manualRecovery.instructions

string

error.manualRecovery.referenceFields

object

Reference identifiers for an operator-driven recovery.

Hide child attributes

error.manualRecovery.referenceFields.transactionId

string

Transaction ID (txn_ prefix).

Pattern: ^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$

error.manualRecovery.referenceFields.sourceTxHash

string

Transaction hash of the originating inbound transfer.

hold

Sender attribution · object

Present while status is awaitingAction; explains the hold + deadline. Populated when the hold model is wired.

Sender attribution
Deposit address frozen
Deposit address inactive

Hide child attributes

hold.type

enum<string>

required

Type discriminator.

Available options:

senderAttribution

hold.required

boolean

Whether the hold is still blocking; false once resolved.

hold.since

string<date-time>

When the hold started.

hold.deadline

string<date-time>

Deadline to resolve before timeout.

hold.resolvedAt

string<date-time>

When the hold was resolved; null while outstanding.

hold.txHash

string

The transaction hash of the unattributed inbound deposit.

hold.matchableExternalAccountCriteria

object

Registering a matching walletExternal EA releases this hold.

Hide child attributes

hold.matchableExternalAccountCriteria.type

enum<string>

Always walletExternal — the EA type that resolves the hold.

Available options:

walletExternal

hold.matchableExternalAccountCriteria.customerId

string

The OMS customer that owns this record (cst_ prefix).

Pattern: ^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$

hold.matchableExternalAccountCriteria.blockchainAddress

string

On-chain address.

hold.matchableExternalAccountCriteria.networkFamily

string

Network family (e.g. evm).

metadata

object

Free-form key-value pairs supplied at creation or update.

Hide child attributes

metadata.{key}

string

createdAt

string<date-time>

When the transaction was created.

updatedAt

string<date-time>

When the transaction was last updated.

expiresAt

string<date-time>

Expiry of the transaction's actionable window: present on auto-created transactions and on cash payouts (the pickup-code expiry), and retained after completion for audit. Null for other quote-initiated transactions.

projectId

string

The owning project. Populated only on the cross-project admin endpoints (e.g. GET /admin/transactions/redrivable) so operators can tell which project a stranded transaction belongs to. Omitted on partner endpoints, where the project is implicit from the auth token.

Pattern: ^prj_.+$

List transactions with filters

Create a cash-in deposit code

⌘I

Overview

Move money

Routes

External Payment Methods

Platform

Get transaction by ID

Authorizations

Path Parameters

Response