HomeGuidesAPI ReferenceChangelog
Log In
API Reference
  1. Braid API
  2. Transactions

Search transactions

post
https://api.sandbox.braid.zone/transaction/search

Returns a paginated list of transactions. Use the projection field in the request body to control the level of detail returned:

  • SUMMARY – core scalar fields only. Fastest.
  • FULL – everything (default).

imad, uetr and achTraceNumber look a transaction up by its network identifier (wire IMAD, wire or FedNow UETR, ACH trace number). They are exact matches and combine with every other filter, in both projections and in the archive.

Query Params
int32
Defaults to 0
int32
Defaults to 100
Body Params
int32

Product ID

string

Account Number

int32

Counterparty ID

int32

Customer ID

date-time

Begin Date

date-time

End Date

date-time

Updated Start Date

date-time

Updated End Date

date-time

Post Date Start

date-time

Post Date End

string

Payment ID

string

Linked Payment ID

number

Minimum Amount

number

Maximum Amount

string

Settlement File Name

string
enum

Transaction Direction

Allowed:
boolean
enum

Is Inbound

Allowed:
boolean
enum

Exclude Wire Transactions

Allowed:
boolean
enum

Exclude ACH Transactions

Allowed:
transactionType
array of strings

Transaction Types

transactionType
transactionStatus
array of strings

Transaction Statuses

transactionStatus
processingStatus
array of strings

Processing Statuses

processingStatus
string

Wire File Handle

boolean
enum

Show ACH NOC

Allowed:
string

External ID

string

Original File Name

string

Requester IP Address

string

Requester Username

string

Loaded From File

string

Batch ID

reconStatuses
array of strings

Reconciliation Statuses

reconStatuses
paymentIds
array of strings

[71cf2c81-1c4f-43ea-bf97-20cd0da36e80]

paymentIds
string

Wire IMAD (final IMAD only; the temporary pre-ACK IMAD is not matched). Exact match.

string

UETR of a wire or a FedNow payment. Exact match against both.

string

ACH trace number. Returns every transaction carrying it (an original entry and its NOC or return share one).

string
enum
Defaults to FULL

Controls how much detail is returned per transaction in search results:

  • SUMMARY: core scalar fields + linked transaction relationships. Fastest option.
  • FULL: everything — parties, instruments, and alert IDs.
Allowed:
boolean

Enables search for archived transaction records

Responses

Updated 17 days ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
*/*

Updated 17 days ago

Did this page help you?