List transactions with filters

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

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

fetch('https://sandbox-api.polygon.technology/v0.13/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.13/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.13/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.13/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>",
      "status": "processing",
      "subStatus": "processing.fundsPulled",
      "customer": {
        "id": "<string>"
      },
      "source": {
        "type": "walletCrypto",
        "asset": "<string>",
        "network": "<string>",
        "id": "<string>",
        "owner": {
          "kind": "counterparty",
          "id": "<string>",
          "name": "<string>"
        },
        "details": {
          "address": "<string>"
        }
      },
      "destination": {
        "type": "walletCrypto",
        "asset": "<string>",
        "network": "<string>",
        "id": "<string>",
        "owner": {
          "kind": "counterparty",
          "id": "<string>",
          "name": "<string>"
        },
        "details": {
          "address": "<string>"
        }
      },
      "pricing": {
        "fees": [
          {
            "type": "<string>",
            "side": "source",
            "asset": "<string>",
            "amount": "<string>"
          }
        ],
        "source": {
          "asset": "<string>",
          "amount": "<string>"
        },
        "destination": {
          "asset": "<string>",
          "amount": "<string>"
        },
        "exchangeRate": "<string>",
        "fixedAmountSide": "source",
        "sponsorGas": true
      },
      "precursor": {
        "type": "quote",
        "id": "<string>"
      },
      "payoutOrigin": {
        "type": "bank",
        "id": "<string>",
        "accountHolder": "customer",
        "accountHolderName": "<string>"
      },
      "transfers": [
        {
          "id": "<string>",
          "role": "deposit",
          "rail": "ach",
          "attempt": 123
        }
      ],
      "failure": {
        "code": "providerError",
        "message": "<string>",
        "retryable": true,
        "bankCode": "<string>"
      },
      "hold": {
        "code": "senderAttribution",
        "message": "<string>",
        "deadline": "2023-11-07T05:31:56Z",
        "match": {
          "address": "<string>",
          "network": "evm"
        }
      },
      "metadata": {},
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

{
  "error": "InvalidFilter",
  "code": 10267,
  "msg": "startingAfter and endingBefore are mutually exclusive",
  "cause": "<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.13/transactions \
  --header 'Authorization: Bearer <token>'

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

fetch('https://sandbox-api.polygon.technology/v0.13/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.13/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.13/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.13/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>",
      "status": "processing",
      "subStatus": "processing.fundsPulled",
      "customer": {
        "id": "<string>"
      },
      "source": {
        "type": "walletCrypto",
        "asset": "<string>",
        "network": "<string>",
        "id": "<string>",
        "owner": {
          "kind": "counterparty",
          "id": "<string>",
          "name": "<string>"
        },
        "details": {
          "address": "<string>"
        }
      },
      "destination": {
        "type": "walletCrypto",
        "asset": "<string>",
        "network": "<string>",
        "id": "<string>",
        "owner": {
          "kind": "counterparty",
          "id": "<string>",
          "name": "<string>"
        },
        "details": {
          "address": "<string>"
        }
      },
      "pricing": {
        "fees": [
          {
            "type": "<string>",
            "side": "source",
            "asset": "<string>",
            "amount": "<string>"
          }
        ],
        "source": {
          "asset": "<string>",
          "amount": "<string>"
        },
        "destination": {
          "asset": "<string>",
          "amount": "<string>"
        },
        "exchangeRate": "<string>",
        "fixedAmountSide": "source",
        "sponsorGas": true
      },
      "precursor": {
        "type": "quote",
        "id": "<string>"
      },
      "payoutOrigin": {
        "type": "bank",
        "id": "<string>",
        "accountHolder": "customer",
        "accountHolderName": "<string>"
      },
      "transfers": [
        {
          "id": "<string>",
          "role": "deposit",
          "rail": "ach",
          "attempt": 123
        }
      ],
      "failure": {
        "code": "providerError",
        "message": "<string>",
        "retryable": true,
        "bankCode": "<string>"
      },
      "hold": {
        "code": "senderAttribution",
        "message": "<string>",
        "deadline": "2023-11-07T05:31:56Z",
        "match": {
          "address": "<string>",
          "network": "evm"
        }
      },
      "metadata": {},
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

{
  "error": "InvalidFilter",
  "code": 10267,
  "msg": "startingAfter and endingBefore are mutually exclusive",
  "cause": "<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, except a deposit the provider reports failed and then completed, which returns to processing.

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. cst_ prefix.

walletId

string

Transactions where this wallet is the source or destination instrument, crypto or fiat alike. Accepts the canonical wlt_ prefix plus the older acc_ and wlt_fiat_ forms.

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. manual matches a transaction with no known origin resource and no recognized out-of-band arrival — this includes a future operator-initiated transaction (rendered {type: manual}). A recognized custodial-wallet deposit, the one out-of-band arrival current data produces, renders {type: walletDeposit} instead; filter on precursorType=walletDeposit to match those rows. reversal is deferred until reversal automation lands. The kind of resource that originated a transaction: quote for a transaction created by accepting a quote, and depositAddress / virtualAccount / cashIn for one created automatically by that resource. walletDeposit covers a custodial-wallet deposit with no originating OMS resource; its id is always null. manual covers a transaction with no known origin resource and does not include wallet deposits; the manual arm (id: null) is reserved for a future operator-initiated transaction and is not emitted yet.

Available options:

quote,

depositAddress,

virtualAccount,

cashIn,

manual,

walletDeposit

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

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

enum<string>

required

Current lifecycle status. See subStatus for finer granularity.

Available options:

processing,

awaitingAction,

completed,

failed

data.subStatus

enum<string>

required

Status-scoped sub-state (e.g. processing.fundsPulled). Always present: each status carries a default member (e.g. processing.initiated) when no more specific value applies.

Available options:

processing.fundsPulled,

processing.cashPickupReady,

processing.underReview,

processing.payoutRetrying,

processing.payoutUnconfirmed,

processing.returningToSender,

completed.cashPickupCollected,

completed.cashPickupExpired,

awaitingAction.informationRequested,

awaitingAction.awaitingSenderAttribution,

awaitingAction.payoutDestinationMissing,

awaitingAction.depositAddressFrozen,

failed.attributionTimeout,

failed.depositAddressFrozenTimeout,

failed.depositAddressInactiveTimeout,

failed.depositAddressClosed,

processing.awaitingCryptoOut,

processing.cryptoOut,

processing.awaitingFiatOut,

processing.fiatOut,

processing.inboundPending,

processing.inboundProcessing,

failed.inboundFailed,

failed.returnedToSender,

processing.initiated,

completed.settled,

failed.unspecified,

failed.expired,

failed.providerDeclined,

failed.outboundFailed

data.customer

object

required

The customer that owns this record — the sender on a transaction.

Hide child attributes

data.customer.id

string

required

The customer id (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

OMS wallet · object

required

The funding side, as an instrument. A bank account carries no rail: how the money moved is on the transaction's transfers.

Hide child attributes

data.source.type

enum<string>

required

Available options:

walletCrypto

data.source.asset

string

required

Lowercase asset.

data.source.network

string

required

Lowercase blockchain.

data.source.id

string

The wallet (wlt_); an older wallet keeps its original wlt_<uuid> id. Left out while a deposit's receiving wallet is not resolved yet.

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

object

Who owns an account that is not the resource's customer's.

Hide child attributes

data.source.owner.kind

enum<string>

required

counterparty, or customer for another customer's account.

Available options:

counterparty,

customer

data.source.owner.id

string

required

The counterparty (ctp_) or customer (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.source.owner.name

string

The counterparty's name. A customer's name is on the customer resource.

data.source.details

object

OMS crypto wallet details.

Hide child attributes

data.source.details.address

string

On-chain address.

data.destination

OMS wallet · object

required

The receiving side, as an instrument. The rail and the ACH options are on the transaction's payout transfer.

Hide child attributes

data.destination.type

enum<string>

required

Available options:

walletCrypto

data.destination.asset

string

required

Lowercase asset.

data.destination.network

string

required

Lowercase blockchain.

data.destination.id

string

The wallet (wlt_); an older wallet keeps its original wlt_<uuid> id. Left out while a deposit's receiving wallet is not resolved yet.

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

object

Who owns an account that is not the resource's customer's.

Hide child attributes

data.destination.owner.kind

enum<string>

required

counterparty, or customer for another customer's account.

Available options:

counterparty,

customer

data.destination.owner.id

string

required

The counterparty (ctp_) or customer (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.destination.owner.name

string

The counterparty's name. A customer's name is on the customer resource.

data.destination.details

object

OMS crypto wallet details.

Hide child attributes

data.destination.details.address

string

On-chain address.

data.pricing

object

required

Consolidated economics.

Hide child attributes

data.pricing.fees

object[]

required

Every fee charged across both sides. [] when there are none — never omitted, never null.

Hide child attributes

data.pricing.fees.type

string

required

Fee kind. OPEN — clients must tolerate an unrecognised type. Known values today: "developer", "oms", "gas".

data.pricing.fees.side

enum<string>

required

Which side this fee was deducted from.

Available options:

source,

destination

data.pricing.fees.asset

string

required

Currency this fee is denominated in — that side's asset.

data.pricing.fees.amount

string

required

Fee amount in asset, at the asset's precision.

data.pricing.source

object

The source side, in the source asset.

Hide child attributes

data.pricing.source.asset

string

required

Lowercase asset of this side, the same as the side's instrument asset.

data.pricing.source.amount

string

On the source, the gross amount the customer pays; on the destination, the amount that arrives. A decimal string at the asset's precision. Always set on the source; set on the destination once priced.

data.pricing.destination

object

The destination side, in the destination asset.

Hide child attributes

data.pricing.destination.asset

string

required

Lowercase asset of this side, the same as the side's instrument asset.

data.pricing.destination.amount

string

data.pricing.exchangeRate

string

Mid-market rate from the source asset to the destination asset, set together with the destination amount. Identity: (source.amount − Σ source fees) × exchangeRate = destination.amount + Σ destination fees.

data.pricing.fixedAmountSide

enum<string>

The side whose amount was fixed at creation. OMS calculated the other side.

Available options:

source,

destination

Present and true when OMS absorbs the destination gas cost; omitted otherwise.

data.precursor

object

What created this transaction, as a uniform {type, id} reference — dereference the resource by id for its full record. A custodial-wallet deposit renders {type: walletDeposit}. Left out for a genuine out-of-band arrival with no recognised origin at all; the manual arm is reserved for a future operator-initiated transaction, distinct from either.

Hide child attributes

data.precursor.type

enum<string>

required

Available options:

quote,

depositAddress,

virtualAccount,

cashIn,

manual,

walletDeposit

data.precursor.id

string | null

required

qt_ / da_ / va_ / ci_. Null for manual and walletDeposit.

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

object

Whose name the payout goes out under. Left out when nothing is paid out to a bank account, a card or a wallet.

Hide child attributes

data.payoutOrigin.type

enum<string>

required

Available options:

bank,

blockchain

data.payoutOrigin.id

string

Public TypeID, e.g. txn_01h455vb4pex5vsknk084sn02q.

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.payoutOrigin.accountHolder

enum<string>

Whose legal identity the payment is sent under. Determined by OMS from the route's configuration — not a request field. Left out when OMS cannot determine it, and on destinations that have no sending legal identity (cash payouts, and crypto payouts outside a Deposit Address). A bank payout that goes out under the payment provider or the partner records that holder just before it is sent to the provider, and reports it only while a payout was or may have been created there; a send interrupted after the holder was recorded and before it went out has an unknown outcome and may report it. A failed send known to have created no payout at the provider, and a payout sent before holders were recorded whose holder could not be recovered afterwards, report the fallback value instead, which may differ from the holder actually used. The fallback value, also reported before a holder is recorded and for payouts that always go out under the customer's own name, is the holder the Deposit Address fixed for the destination type the transaction pays on a transaction created from a Deposit Address, and the value its route implies on any other.

Available options:

customer,

paymentProvider,

partner

data.payoutOrigin.accountHolderName

string

The legal name the payment is sent under, resolved from accountHolder — the customer's own legal name for customer, the owning customer's legal name for partner (for now; a partner-level name may replace it later), or the payment provider's name for paymentProvider, which differs between a bank origin ("Coinme Inc FBO its Customers") and a blockchain origin. This is what the recipient sees as the sender. Like accountHolder and unlike id, it is populated as soon as it is determinable, so it appears on Quote, Deposit Address and Virtual Account responses as well as Transactions. Left out whenever accountHolder is, and when the customer's name cannot be read at that moment.

data.transfers

object[]

The transaction's transfers, in creation order: each movement of its money on one rail. Left out until the first transfer exists; fetch one with GET /transfers/{transferId}.

Hide child attributes

data.transfers.id

string

required

Transfer ID (trf_ 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.transfers.role

enum<string>

required

What a transfer does in its transaction. deposit brings money in, payout sends it out and refund sends it back to the sender. A bank return is the transfer's returned status, not a role.

Available options:

deposit,

payout,

refund

data.transfers.rail

enum<string>

required

How a transfer's money moved.

Available options:

ach,

achSameDay,

wire,

internationalWire,

rtp,

bookTransfer,

blockchain,

card,

cash

data.transfers.attempt

integer<int32>

required

1 for the first send; a payout sent again after a confirmed failure is a new transfer with attempt + 1.

data.failure

object

Why the transaction failed. Present only when status is failed.

Hide child attributes

data.failure.code

enum<string>

required

What went wrong.

Available options:

providerError,

providerRejected,

providerTimeout,

expired,

systemError,

provisioningTimeout,

insufficientFunds,

providerAmountBelowMinimum,

limitExceeded,

outsideSellBounds,

outsideSellVelocityBounds,

unusableAmount,

unsupportedCorridor,

outgoingRailNotEnabled,

ssnNotVerified,

riskRejected,

cardDeclined,

bankSellDeclined,

payoutFailed,

priceMoved,

returningToSender,

returnedToSender,

returnFailed,

depositFailed,

attributionTimeout,

assetMismatch,

chainMismatch,

misattributedArrival,

depositAddressNotActive,

virtualAccountNotActive,

counterpartyArchived,

destinationUnavailable,

walletClaimed,

walletBoundToCustodialFlow,

projectSuspended,

memoInvalid,

cashDepositFailed,

noMatchingNetwork,

blockchainAddressInUse,

bankAccountInUse,

bankAccountRejected,

deletePendingTimeout,

providerAccountMissing,

cardInUse,

cardLimitReached,

countryProhibited,

countryNotSupported,

cardVerificationDeclined,

bankVerificationDeclined,

accountClosed,

accountFrozenByBank,

routingOrAccountNumberInvalid,

accountHolderDeceased,

accountDoesNotSupportTransfers,

payeeNameMismatch,

walletUnreachableOnNetwork,

billingAddressMismatch,

cardExpired,

cardClosedOrLostStolen,

pushToCardUnsupported,

cardDeclinedByIssuer

data.failure.message

string

required

A fixed, vendor-neutral sentence for code.

data.failure.retryable

boolean

required

Whether trying the same thing again can succeed.

data.failure.bankCode

string

The bank's own return code, only on an external account a bank return made invalid.

data.hold

object

What the partner must do while status is awaitingAction. Left out in every other status.

Hide child attributes

data.hold.code

enum<string>

required

Why the resource is held.

Available options:

senderAttribution,

payoutDestinationMissing

data.hold.message

string

required

A fixed, vendor-neutral sentence for code.

data.hold.deadline

string<date-time>

When the hold times out and the transaction fails. Only on senderAttribution.

data.hold.match

object

The sender's address and network to register to release the hold. Only on senderAttribution.

Hide child attributes

data.hold.match.address

string

required

The sender's on-chain address.

data.hold.match.network

enum<string>

required

The network family of the sender's address.

Available options:

evm,

solana,

tron

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.

Overview

Move money

Routes

External Payment Methods

Platform

List transactions with filters

Authorizations

Query Parameters

Response