Jump to Content
Home
Guides
API Reference
Changelog
v1.5.0
v1.6.0
v1.6.1
v1.7.0
v1.8.0
Log In
API Reference
Log In
v1.8.0
Home
Guides
API Reference
Changelog
Add notes to an alert
Search
All
Pages
Start typing to search…
JUMP TO
Braid API
Webhook responses
Response example for WIRE_TRANSACTION_STATUS_UPDATE event for WIRE_DOMESTIC_DEBIT
post
Response example for WIRE_OUTBOUND_SUBMITTED event
post
Response example for WIRE_OUTBOUND_SENT event
post
Response example for WIRE_OUTBOUND_POSTED event
post
Response example for WIRE_OUTBOUND_CANCELED event
post
Response example for WIRE_INBOUND_RETURNED event
post
Response example for WIRE_INBOUND_POSTED event
post
Response example for WIRE_INBOUND_MANUAL_REVIEW event
post
Response example for WIRE_INBOUND_CANCELLED event
post
Response example for TRANSACTION_STATUS_UPDATE event for ACH_RETURNED_ORIGINATOR_CREDIT
post
Response example for TRANSACTION_STATUS_UPDATE event for ACH_ORIGINATOR_CREDIT
post
Response example for SAVINGS_ACCOUNT_INTEREST_PAYOUT_POSTED event
post
Response example for RFI_STATUS_UPDATE event
post
Response example for FED_SETTLEMENT_FILE_PARSING_RESULT event
post
Response example for CUSTOMER_STATUS event
post
Response example for CUSTOMER_CIP_UPDATE event
post
Response example for COUNTERPARTY_STATUS event
post
Response example for ALERT_CREATED event
post
Response example for ACH_OUTBOUND_POSTED event
post
Response example for ACH_ORIGINATION_SUBMITTED event
post
Response example for ACH_ORIGINATION_SENT event
post
Response example for ACH_ORIGINATION_RETURNED event
post
Response example for ACH_ORIGINATION_REJECTED event
post
Response example for ACH_ORIGINATION_MANUAL_REVIEW event
post
Response example for ACH_ORIGINATION_CANCELED event
post
Response example for ACH_NOC event
post
Response example for ACH_INBOUND_RETURNED event
post
Response example for ACH_INBOUND_REJECTED event
post
Response example for ACH_INBOUND_POSTED event
post
Response example for ACH_INBOUND_MANUAL_REVIEW event
post
Response example for ACH_INBOUND_CANCELLED event
post
Response example for ACCOUNT_TO_ACCOUNT event
post
Response example for ACCOUNT_CREATED event
post
Statements V2
Get summary account statement
get
Accounts
Open a new account for an individual customer
post
Open a new account for a business customer
post
Retrieve a specific account by its account number
get
Update the updatable properties of an account
patch
Update status of an account
patch
Get list of all accounts
get
Retrieve balance details for an account
get
Simulation
Simulate WIRE outbound return transaction
post
Simulate WIRE inbound transaction
post
Simulate ACH outbound return transaction
post
Simulate a notice of change to an existing ACH transaction
post
Simulate ACH inbound transaction
post
Identity Verification
Create Identity Verification
post
Get customer identity verification
get
Individuals
Upload a file for a document
put
Create an individual
post
Get documents belong to an individual
get
Create a document for an Individual
post
Get a list of Individuals
post
Get details of an individual
get
Update the details of an Individual
patch
Webhook
Get a list of webhooks
get
Create a webhook
post
Re-publish webhook by payment ID
post
Search webhook logs
post
Get details of a webhook
get
Delete a webhook
del
Update a webhook
patch
Get a list of webhook event
get
Alerts
Upload a file for a document
put
Create a document for an alert
put
Add notes to an alert
put
Get a list of alerts
post
Update alerts request for information status. This endpoint is only for Admin and Developers use. Only admins can set the status to COMPLETED.
post
Get details of an alert
get
Fees
Get the details of a fee V2
get
Update a fee V2
put
Delete a fee V2
del
Get the details of a fee
get
Update a fee
put
Delete a fee
del
Create a fee V2
post
Search Fees
post
Get a list of fees
get
Create a fee
post
Get active fee for account
get
Counterparty
Get counterparty V2
get
Update a counterparty V2
put
Get counterparty
get
Update a counterparty
put
Create a counterparty V2
post
Create a counterparty
post
Search Counterparties
post
Transactions
Upload document for transaction
put
Create document for transaction
put
Cancel a pending transaction
put
Developer approve a pending transaction
put
Perform an INTERNATIONAL WIRE outbound transaction. This new version of the endpoint optionally supports Foreign Exchange and non-USD currencies.
post
Return a wire deposit
post
Perform a DOMESTIC WIRE outbound transaction
post
Perform an INTERNATIONAL WIRE outbound transaction
post
Search transactions
post
Perform an internal transfer transaction
post
List past Foreign Exchange quotes
get
Create a quote for Foreign Exchange trade, if that functionality is available. This does not create any transactions. The quote may be used to create an international wire.
post
Apply a one-time fee debit
post
Perform a FedNow outbound transaction
post
Further credit the transaction to the ultimate beneficiary account
post
Perform a batch
post
Perform an ACH withdrawal transaction
post
Reverse an ACH transaction by its paymentId
post
Perform an ACH push transaction
post
Perform an ACH pull transaction
post
Perform an ACH funding transaction
post
Get list of all active transaction types
get
Get detailed metadata for all active transaction types
get
Get list of all active transaction groups
get
Get information about a batch
get
Retrieve the original request that was used to create a batch
get
Businesses
Get details of an UBO
get
Update the details of an UBO
put
Delete an UBO
del
Upload a file for a document
put
Get list of all business customers
get
Create a business
post
Get UBOs belong to a business
get
Create a UBO for a business
post
Delete external ACH payment instrument of business
del
Get documents belong to a business
get
Create a document for a business
post
Get a list of businesses
post
Get details of a business
get
Update the details of a business
patch
ACH Processing
Upload outbound ACH file
post
Get ACH file processing stats
get
Statements
Get product statement
get
Powered by
Add notes to an alert
put
https://api.sandbox.braid.zone/alerts/
{alertId}
/add-note
Language
Shell
Node
Ruby
PHP
Python
Response
Click
Try It!
to start a request and see the response here!
