List transactions with filters

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

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

fetch('https://sandbox-api.polygon.technology/v0.11/transactions', 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",
  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"

	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")

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

{
  "object": "<string>",
  "limit": 123,
  "hasMore": true,
  "nextCursor": "<string>",
  "previousCursor": "<string>",
  "data": [
    {
      "id": "<string>",
      "object": "transaction",
      "customerId": "<string>",
      "precursor": {
        "type": "depositAddress",
        "details": {
          "depositAddressId": "<string>",
          "depositInstructions": {
            "asset": "<string>",
            "network": "<string>",
            "address": "<string>",
            "expiresAt": "2023-11-07T05:31:56Z"
          }
        }
      },
      "source": {
        "type": "walletOms",
        "category": "crypto",
        "details": {
          "id": "<string>",
          "asset": "<string>",
          "network": "<string>",
          "blockchainAddress": "<string>",
          "txHash": "<string>",
          "blockchainAsset": {
            "chainId": "<string>",
            "tokenId": "<string>"
          }
        },
        "party": {
          "relationship": "customer",
          "customerId": "<string>"
        }
      },
      "destination": {
        "type": "walletOms",
        "category": "crypto",
        "details": {
          "id": "<string>",
          "asset": "<string>",
          "network": "<string>",
          "blockchainAddress": "<string>",
          "txHash": "<string>",
          "blockchainAsset": {
            "chainId": "<string>",
            "tokenId": "<string>"
          }
        },
        "party": {
          "relationship": "customer",
          "customerId": "<string>"
        },
        "payoutOrigin": {
          "type": "bank",
          "details": {
            "accountHolder": "customer",
            "accountHolderName": "<string>",
            "accountNumber": "<string>",
            "routingNumber": "<string>",
            "virtualAccountId": "<string>"
          }
        }
      },
      "pricing": {
        "source": {
          "asset": "<string>",
          "amountGross": "<string>",
          "amountNet": "<string>",
          "feesDeducted": {
            "total": "<string>",
            "developer": "<string>",
            "oms": "<string>",
            "gas": "<string>"
          }
        },
        "destination": {
          "asset": "<string>",
          "amountGross": "<string>",
          "amountNet": "<string>",
          "feesDeducted": {
            "total": "<string>",
            "developer": "<string>",
            "oms": "<string>",
            "gas": "<string>"
          }
        },
        "pair": "<string>",
        "exchangeRate": "<string>",
        "effectiveRate": "<string>",
        "sponsorGas": true,
        "sponsorGasCost": "<string>"
      },
      "estimatedArrival": "2023-11-07T05:31:56Z",
      "error": {
        "code": "<string>",
        "message": "<string>",
        "occurredAt": "2023-11-07T05:31:56Z",
        "recoverable": true,
        "manualRecovery": {
          "type": "manualRecovery",
          "instructions": "<string>",
          "referenceFields": {
            "transactionId": "<string>",
            "sourceTxHash": "<string>"
          }
        }
      },
      "hold": {
        "type": "senderAttribution",
        "required": true,
        "since": "2023-11-07T05:31:56Z",
        "deadline": "2023-11-07T05:31:56Z",
        "resolvedAt": "2023-11-07T05:31:56Z",
        "txHash": "<string>",
        "matchableExternalAccountCriteria": {
          "type": "walletExternal",
          "customerId": "<string>",
          "blockchainAddress": "<string>",
          "networkFamily": "<string>"
        }
      },
      "metadata": {},
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "expiresAt": "2023-11-07T05:31:56Z",
      "projectId": "<string>"
    }
  ]
}

Transactions

List transactions with filters

List transactions with filters.

Results are ordered newest-first (by createdAt desc, id desc). limit defaults to 50 and is capped at 100.

Date filters createdAfter and createdBefore are inclusive (treated as >= and <= against createdAt).

Pagination returns opaque nextCursor / previousCursor tokens in the response whenever the page is non-empty: use startingAfter=nextCursor to fetch the next page, or endingBefore=previousCursor to page backward. hasMore tells the client whether more rows exist in the current direction of travel; an empty response in the other direction signals the start of the list.

GET

transactions

List transactions with filters

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

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

fetch('https://sandbox-api.polygon.technology/v0.11/transactions', 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",
  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"

	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")

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

{
  "object": "<string>",
  "limit": 123,
  "hasMore": true,
  "nextCursor": "<string>",
  "previousCursor": "<string>",
  "data": [
    {
      "id": "<string>",
      "object": "transaction",
      "customerId": "<string>",
      "precursor": {
        "type": "depositAddress",
        "details": {
          "depositAddressId": "<string>",
          "depositInstructions": {
            "asset": "<string>",
            "network": "<string>",
            "address": "<string>",
            "expiresAt": "2023-11-07T05:31:56Z"
          }
        }
      },
      "source": {
        "type": "walletOms",
        "category": "crypto",
        "details": {
          "id": "<string>",
          "asset": "<string>",
          "network": "<string>",
          "blockchainAddress": "<string>",
          "txHash": "<string>",
          "blockchainAsset": {
            "chainId": "<string>",
            "tokenId": "<string>"
          }
        },
        "party": {
          "relationship": "customer",
          "customerId": "<string>"
        }
      },
      "destination": {
        "type": "walletOms",
        "category": "crypto",
        "details": {
          "id": "<string>",
          "asset": "<string>",
          "network": "<string>",
          "blockchainAddress": "<string>",
          "txHash": "<string>",
          "blockchainAsset": {
            "chainId": "<string>",
            "tokenId": "<string>"
          }
        },
        "party": {
          "relationship": "customer",
          "customerId": "<string>"
        },
        "payoutOrigin": {
          "type": "bank",
          "details": {
            "accountHolder": "customer",
            "accountHolderName": "<string>",
            "accountNumber": "<string>",
            "routingNumber": "<string>",
            "virtualAccountId": "<string>"
          }
        }
      },
      "pricing": {
        "source": {
          "asset": "<string>",
          "amountGross": "<string>",
          "amountNet": "<string>",
          "feesDeducted": {
            "total": "<string>",
            "developer": "<string>",
            "oms": "<string>",
            "gas": "<string>"
          }
        },
        "destination": {
          "asset": "<string>",
          "amountGross": "<string>",
          "amountNet": "<string>",
          "feesDeducted": {
            "total": "<string>",
            "developer": "<string>",
            "oms": "<string>",
            "gas": "<string>"
          }
        },
        "pair": "<string>",
        "exchangeRate": "<string>",
        "effectiveRate": "<string>",
        "sponsorGas": true,
        "sponsorGasCost": "<string>"
      },
      "estimatedArrival": "2023-11-07T05:31:56Z",
      "error": {
        "code": "<string>",
        "message": "<string>",
        "occurredAt": "2023-11-07T05:31:56Z",
        "recoverable": true,
        "manualRecovery": {
          "type": "manualRecovery",
          "instructions": "<string>",
          "referenceFields": {
            "transactionId": "<string>",
            "sourceTxHash": "<string>"
          }
        }
      },
      "hold": {
        "type": "senderAttribution",
        "required": true,
        "since": "2023-11-07T05:31:56Z",
        "deadline": "2023-11-07T05:31:56Z",
        "resolvedAt": "2023-11-07T05:31:56Z",
        "txHash": "<string>",
        "matchableExternalAccountCriteria": {
          "type": "walletExternal",
          "customerId": "<string>",
          "blockchainAddress": "<string>",
          "networkFamily": "<string>"
        }
      },
      "metadata": {},
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "expiresAt": "2023-11-07T05:31:56Z",
      "projectId": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Token from POST /auth/token

Query Parameters

limit

integer<int32>

Page size, supported range 1-100. The default and maximum are per-resource (see each endpoint's description; most endpoints default to 50) and are resolved at runtime from configuration. Values outside the range are clamped to the nearest bound rather than rejected. The range is published machine-readably via the x-minimum/x-maximum OpenAPI extensions below — deliberately NOT via @minValue/@maxValue, which emit JSON-Schema minimum/maximum and make the generated SDK (Zod) reject values the server accepts and clamps. See PaginatedList.limit for the effective value applied.

startingAfter

string

endingBefore

string

status

enum<string>[]

Filter by status.

Lifecycle of a transaction. processing: funds in motion. awaitingAction: non-terminal, blocked on developer/upstream/compliance (see hold); returns to processing once cleared. completed: delivered. failed: terminal failure.

Available options:

processing,

awaitingAction,

completed,

failed

sourceToDestination

enum<string>[]

Filter by corridor (source/destination category composite).

Composite of source and destination instrument categories, inferred from each side. The cash corridors (cryptoToCash, cashToCrypto) are derived from a cash-pickup destination / cash-in source respectively; the rest map straight from the internal corridor type.

Available options:

cryptoToCrypto,

cryptoToCash,

cryptoToFiatAccount,

cashToCrypto,

fiatAccountToCrypto,

fiatAccountToFiatAccount

customerId

string

Scope to a customer. Matches rows where the customer is on either side — the sender (quote owner) or the recipient. Replaces the retired GET /customers/{id}/transactions. cst_ prefix.

walletId

string

Filter to the transaction's originating OMS wallet (the precursor's source wallet). wlt_ prefix (legacy acc_ also accepted).

virtualAccountId

string

Filter to the transaction's originating virtual account. va_ prefix.

depositAddressId

string

Filter to the transaction's originating deposit address. da_ prefix.

cashInId

string

Filter to the transaction's originating cash-in. ci_ prefix.

precursorType

enum<string>

Filter by the kind of precursor that originated the transaction. Matches transactions where ANY leg carries a precursor of this type (consistent with the id filters above). This may differ from the single precursor object rendered on the transaction: when a leg has several precursor sources, the rendered precursor reports one winner by fixed precedence (depositAddress > virtualAccount > cashIn > quote), so a transaction can match e.g. precursorType=quote while its rendered precursor.type is depositAddress. reversal is deferred until reversal automation lands. The kind of precursor resource that originated a transaction. reversal is deliberately absent until reversal automation lands (#2141).

Available options:

quote,

depositAddress,

virtualAccount,

cashIn

createdAfter

string<date-time>

Inclusive lower bound on createdAt.

createdBefore

string<date-time>

Inclusive upper bound on createdAt.

string

Free-text search. Matches transaction id, customer id, or customer email.

string

Alias for search.

legStatus

string[]

Filters to payments where ANY leg's underlying status is in the given set (e.g. failed surfaces outbound-failed-funds-held payments whose derived overall status is still processing). Values are leg-level statuses, a superset of TransactionStatus. Only applied under the grouped read model; ignored otherwise.

Response

200 - application/json

The request has succeeded.

A paginated list of transactions.

object

string

Resource type discriminator.

limit

integer<int32>

The effective page size applied to this response, after clamping an out-of-range or unset requested limit into the supported bound.

hasMore

boolean

True when more rows exist beyond this page in the direction of travel (forward by default, backward when endingBefore was supplied).

nextCursor

string

Opaque cursor pointing at the last item in this page. Present when data is non-empty. Pass as startingAfter to fetch the next page; hasMore=false signals no more pages forward.

previousCursor

string

Opaque cursor pointing at the first item in this page. Present when data is non-empty. Pass as endingBefore to page backward; when this yields an empty response the client is at the start of the list.

data

object[]

The page of results.

Hide child attributes

data.id

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})$

data.object

enum<string>

required

Resource type discriminator. Always "transaction".

Available options:

transaction

data.status

enum<string>

required

Current lifecycle status. See subStatus for finer granularity.

Available options:

processing,

awaitingAction,

completed,

failed

data.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})$

data.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

data.precursor.type

enum<string>

required

Type discriminator.

Available options:

depositAddress

data.precursor.details

object

required

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

Hide child attributes

data.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})$

data.precursor.details.depositInstructions

object

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

Hide child attributes

data.precursor.details.depositInstructions.asset

string

required

Same value as expectedSourceAsset.

data.precursor.details.depositInstructions.network

string

required

Same value as expectedSourceNetwork.

data.precursor.details.depositInstructions.address

string

required

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

data.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.

data.source

OMS wallet · object

required

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

Hide child attributes

data.source.type

enum<string>

required

Type discriminator.

Available options:

walletOms

data.source.category

enum<string>

required

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

Available options:

crypto

data.source.details

object

required

WalletOms instrument details: an OMS-custodied crypto wallet.

Hide child attributes

data.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})$

data.source.details.asset

string

Canonical asset identifier.

data.source.details.network

string

Network identifier.

data.source.details.blockchainAddress

string

On-chain address.

data.source.details.custodyType

enum<string>

How the wallet is held: custodial or embedded.

Available options:

custodial,

embedded

data.source.details.txHash

string

On-chain transaction hash.

data.source.details.blockchainAsset

object

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

Hide child attributes

data.source.details.blockchainAsset.protocol

enum<string>

required

Available options:

evm,

svm,

sui

data.source.details.blockchainAsset.chainId

string

required

data.source.details.blockchainAsset.tokenId

string

required

data.source.party

Customer · object

Structured identity of who is on this side.

Customer
Another customer
Registered external account
Unregistered external account

Hide child attributes

data.source.party.relationship

enum<string>

required

Relationship discriminator.

Available options:

customer

data.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})$

data.source.party.entityType

enum<string>

Available options:

individual,

business

data.destination

OMS wallet · object

required

The receiving side: a typed instrument plus payoutOrigin.

Hide child attributes

data.destination.type

enum<string>

required

Type discriminator.

Available options:

walletOms

data.destination.category

enum<string>

required

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

Available options:

crypto

data.destination.details

object

required

WalletOms instrument details: an OMS-custodied crypto wallet.

Hide child attributes

data.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})$

data.destination.details.asset

string

Canonical asset identifier.

data.destination.details.network

string

Network identifier.

data.destination.details.blockchainAddress

string

On-chain address.

data.destination.details.custodyType

enum<string>

How the wallet is held: custodial or embedded.

Available options:

custodial,

embedded

data.destination.details.txHash

string

On-chain transaction hash.

data.destination.details.blockchainAsset

object

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

Hide child attributes

data.destination.details.blockchainAsset.protocol

enum<string>

required

Available options:

evm,

svm,

sui

data.destination.details.blockchainAsset.chainId

string

required

data.destination.details.blockchainAsset.tokenId

string

required

data.destination.party

Customer · object

Structured identity of who is on this side.

Customer
Another customer
Registered external account
Unregistered external account

Hide child attributes

data.destination.party.relationship

enum<string>

required

Relationship discriminator.

Available options:

customer

data.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})$

data.destination.party.entityType

enum<string>

Available options:

individual,

business

data.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

data.destination.payoutOrigin.type

enum<string>

required

Type discriminator.

Available options:

bank

data.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

data.destination.payoutOrigin.details.accountHolder

enum<string>

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

Available options:

customer

data.destination.payoutOrigin.details.accountHolderName

string

Name of the sending account holder.

data.destination.payoutOrigin.details.accountNumber

string | null

Bank account number.

data.destination.payoutOrigin.details.routingNumber

string | null

US ABA routing number.

data.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})$

data.pricing

object

required

Consolidated economics.

Hide child attributes

data.pricing.source

object

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

Hide child attributes

data.pricing.source.asset

string

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

data.pricing.source.amountGross

string

Amount on this side before fees are applied.

data.pricing.source.amountNet

string

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

data.pricing.source.feesDeducted

object

Itemized fees deducted on this side.

Hide child attributes

data.pricing.source.feesDeducted.total

string

required

data.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.

data.pricing.source.feesDeducted.oms

string

required

data.pricing.source.feesDeducted.gas

string

required

data.pricing.destination

object

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

Hide child attributes

data.pricing.destination.asset

string

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

data.pricing.destination.amountGross

string

Amount on this side before fees are applied.

data.pricing.destination.amountNet

string

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

data.pricing.destination.feesDeducted

object

Itemized fees deducted on this side.

Hide child attributes

data.pricing.destination.feesDeducted.total

string

required

data.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.

data.pricing.destination.feesDeducted.oms

string

required

data.pricing.destination.feesDeducted.gas

string

required

data.pricing.pair

string

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

data.pricing.exchangeRate

string

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

data.pricing.effectiveRate

string

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

data.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.

data.sourceToDestination

enum<string>

Corridor composite derived from the two sides.

Available options:

cryptoToCrypto,

cryptoToCash,

cryptoToFiatAccount,

cashToCrypto,

fiatAccountToCrypto,

fiatAccountToFiatAccount

data.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

data.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.

data.error

object

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

Hide child attributes

data.error.code

string

required

Machine-readable code.

data.error.message

string

required

Human-readable detail.

data.error.occurredAt

string<date-time>

required

When the error occurred.

data.error.recoverable

boolean

required

Whether the failure can be recovered.

data.error.manualRecovery

object

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

Hide child attributes

data.error.manualRecovery.type

enum<string>

Available options:

manualRecovery

data.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

data.error.manualRecovery.instructions

string

data.error.manualRecovery.referenceFields

object

Reference identifiers for an operator-driven recovery.

Hide child attributes

data.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})$

data.error.manualRecovery.referenceFields.sourceTxHash

string

Transaction hash of the originating inbound transfer.

data.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

data.hold.type

enum<string>

required

Type discriminator.

Available options:

senderAttribution

data.hold.required

boolean

Whether the hold is still blocking; false once resolved.

data.hold.since

string<date-time>

When the hold started.

data.hold.deadline

string<date-time>

Deadline to resolve before timeout.

data.hold.resolvedAt

string<date-time>

When the hold was resolved; null while outstanding.

data.hold.txHash

string

The transaction hash of the unattributed inbound deposit.

data.hold.matchableExternalAccountCriteria

object

Registering a matching walletExternal EA releases this hold.

Hide child attributes

data.hold.matchableExternalAccountCriteria.type

enum<string>

Always walletExternal — the EA type that resolves the hold.

Available options:

walletExternal

data.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})$

data.hold.matchableExternalAccountCriteria.blockchainAddress

string

On-chain address.

data.hold.matchableExternalAccountCriteria.networkFamily

string

Network family (e.g. evm).

data.metadata

object

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

Hide child attributes

data.metadata.{key}

string

data.createdAt

string<date-time>

When the transaction was created.

data.updatedAt

string<date-time>

When the transaction was last updated.

data.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.

data.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_.+$

Execute a transaction (send)

Get transaction by ID

⌘I

Overview

Move money

Routes

External Payment Methods

Platform

List transactions with filters

Authorizations

Query Parameters

Response