Trice Hub API

Introduction
Build
- Retrieve buildget
Account
- Retrieve accountget
Accounts
Enrollments
Bank Capabilities
Persons
Parties
Balance
- Retrieve account balanceget
- Retrieve an enrollment balanceget
Balance Transactions
- Retrieve balance transactionsget
- Retrieve a balance transactionget
Transfers
Transfer Reversals
ABA Routing Support
- Retrieve ABA routing supportget
Network Status
- Retrieve Network Status Detailsget
Smart Transfer
- Create an RTP or FedNow transferpost
Smart Verify
- Create an RTP or FedNow verification transferpost
FedNow Transfers
RTP Transfers
RTP RfP Presentments
RTP RfPs
Web Hooks
States
RTP/FedNow System Codes

Trice Auth API

Build
- Retrieve buildget
Authentication
- Create a tokenpost

Trice Hub API

Introduction
Build
- Retrieve buildget
Account
- Retrieve accountget
Accounts
Enrollments
Bank Capabilities
Persons
Parties
Balance
- Retrieve account balanceget
- Retrieve an enrollment balanceget
Balance Transactions
- Retrieve balance transactionsget
- Retrieve a balance transactionget
Transfers
Transfer Reversals
ABA Routing Support
- Retrieve ABA routing supportget
Network Status
- Retrieve Network Status Detailsget
Smart Transfer
- Create an RTP or FedNow transferpost
Smart Verify
- Create an RTP or FedNow verification transferpost
FedNow Transfers
RTP Transfers
RTP RfP Presentments
RTP RfPs
Web Hooks
States
RTP/FedNow System Codes

Trice Auth API

Build
- Retrieve buildget
Authentication
- Create a tokenpost

Create Web Hook

post https://api-sandbox.trice.co/hub/v1/web_hooks/{type}

Creates a web hook for fednow_transfer_outbound,fednow_transfer_inbound,rtp_transfer_outbound, rtp_transfer_inbound, rtp_rfp_inbound, rtp_rfp_outbound, rtp_rfp_presentment, open_banking_session, party, account, person, network_status, enrollment_balance or default

URL Expired

The URL for this request expired after 30 days.

Path Params

type

string

required

The type of webhook: fednow_transfer_outbound,fednow_transfer_inbound,rtp_transfer_inbound,rtp_transfer_outbound,rtp_rfp_inbound,rtp_rfp_outbound, rtp_rfp_presentment, open_banking_session, party, account, person, network_status, enrollment_balance or default

Body Params

web hook body

options

object

Options that are specific to certain webhook types including enrollment_balance and default. Creating options with other webhooks will fail.

uri

string

length ≤ 200

URI of the webhook callback.

Headers

X-TRICE-ACCOUNT

uuid

A parent account can include this header as reference to the descendent account being operated on.

Responses

Response body

object

created

string

Formated timestamp (YYYY-MM-DD HH:MM:SS) determining when the web hook was created.

uuid

Unique web hook id (RFC-4122 UUID).

options

object | null

Options that are specific to certain webhook types including enrollment_balance and default. Creating options with other webhooks will fail.

enrollment_balance_thresholds

array of objects or null

List of enrollments and associated available funds thresholds.

enrollment_balance_thresholds

object | null

available_at_rtp_threshold

int64

If the balance of the associated enrollment at RTP joint fund changes and the new balance is under this threshold then the webhook is triggered. The value is in cents. payout and topup transactions will NOT trigger a webhook.

available_threshold

int64

≥ 0

If the balance of the associated enrollment changes and the new balance is under this threshold then the webhook is triggered. The value is in cents. If the value is 0 then any balance change will trigger a webhook. payout and topup transactions will NOT trigger a webhook.

enrollment_id

uuid

The unique ID (RFC-4122 UUID) of the bank account enrollment to check the balance of. If omitted all enrollment ids will be checked.

secret_key

string

base64 encoded 32 byte secret key used to sign the request body.

updated

string | null

Formatted timestamp (YYYY-MM-DD HH:MM:SS) determining when the web hook was last updated.

uri

string | null

URI of the webhook callback.

Response body

object

errors

array of objects

required

errors*

object

message

string

path

string

Response body

object

errors

array of objects

required

errors*

object

message

string

path

string

Response body

object

errors

array of objects

required

errors*

object

message

string

path

string

Response body

object

errors

array of objects

required

errors*

object

message

string

path

string

Response body

object

errors

array of objects

required

errors*

object

message

string

path

string

Updated 6 months ago

Usage

Retrieve Web Hooks

Did this page help you?

Language

Credentials

Bearer

JWT


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api-sandbox.trice.co/hub/v1/web_hooks/fednow_transfer_outbound \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated 6 months ago

Usage

Retrieve Web Hooks

Did this page help you?

Trice Hub API
Introduction
Build
Retrieve buildget
Account
Retrieve accountget
Accounts
Delete an Accountdelete
Update an Accountput
Retrieve an Accountget
Retrieve accountsget
Create an Accountpost
Enrollments
Update an enrollmentput
Retrieve an Enrollmentget
Retrieve Enrollmentsget
Create an enrollmentpost
Bank Capabilities
Delete a bank_capabilitydelete
Update a bank_capabilityput
Retrieve a bank_capabilityget
Retrieve bank_capabilitiesget
Create a bank_capabilitypost
Persons
Delete a Persondelete
Update a Personput
Retrieve a Personget
Retrieve Personsget
Create a Personpost
Parties
Delete a partydelete
Update a partyput
Retrieve a partyget
Retrieve partiesget
Create a partypost
Balance
Retrieve an enrollment balanceget
Retrieve account balanceget
Balance Transactions
Retrieve a balance transactionget
Retrieve balance transactionsget
Transfers
Retrieve an internal transferget
Retrieve internal transfersget
Create an internal transferpost
Transfer Reversals
Retrieve an internal transfer reversalget
Retrieve internal transfersget
Create an internal transfer reversalpost
ABA Routing Support
Retrieve ABA routing supportget
Network Status
Retrieve Network Status Detailsget
Smart Transfer
Create an RTP or FedNow transferpost
Smart Verify
Create an RTP or FedNow verification transferpost
FedNow Transfers
Retrieve a FedNow transferget
Retrieve FedNow transfersget
Create a FedNow transferpost
FedNow Credit Transfer
RTP Transfers
Retrieve an RTP transferget
Retrieve RTP transfersget
Create a RTP transferpost
RTP Credit Transfer
RTP RfP Presentments
Delete a RTP RfP presentmentdelete
Retrieve a RTP RfP presentmentget
Retrieve RTP RfP presentmentsget
Create a RTP RfP presentmentpost
RTP RfP Presentment
RTP RfPs
Update a RTP RfPput
Retrieve a RTP RfPget
Retrieve RTP RfPsget
Create a RTP RfPpost
Request For Payment (RfP)
Web Hooks
Delete a Web Hookdelete
Update a web hookput
Retrieve a web hookget
Retrieve Web Hooksget
Create Web Hookpost
Usage
States
RTP/FedNow System Codes

Trice Auth API
Build
Retrieve buildget
Authentication
Create a tokenpost

Trice Hub API
Introduction
Build
Retrieve buildget
Account
Retrieve accountget
Accounts
Delete an Accountdelete
Update an Accountput
Retrieve an Accountget
Retrieve accountsget
Create an Accountpost
Enrollments
Update an enrollmentput
Retrieve an Enrollmentget
Retrieve Enrollmentsget
Create an enrollmentpost
Bank Capabilities
Delete a bank_capabilitydelete
Update a bank_capabilityput
Retrieve a bank_capabilityget
Retrieve bank_capabilitiesget
Create a bank_capabilitypost
Persons
Delete a Persondelete
Update a Personput
Retrieve a Personget
Retrieve Personsget
Create a Personpost
Parties
Delete a partydelete
Update a partyput
Retrieve a partyget
Retrieve partiesget
Create a partypost
Balance
Retrieve an enrollment balanceget
Retrieve account balanceget
Balance Transactions
Retrieve a balance transactionget
Retrieve balance transactionsget
Transfers
Retrieve an internal transferget
Retrieve internal transfersget
Create an internal transferpost
Transfer Reversals
Retrieve an internal transfer reversalget
Retrieve internal transfersget
Create an internal transfer reversalpost
ABA Routing Support
Retrieve ABA routing supportget
Network Status
Retrieve Network Status Detailsget
Smart Transfer
Create an RTP or FedNow transferpost
Smart Verify
Create an RTP or FedNow verification transferpost
FedNow Transfers
Retrieve a FedNow transferget
Retrieve FedNow transfersget
Create a FedNow transferpost
FedNow Credit Transfer
RTP Transfers
Retrieve an RTP transferget
Retrieve RTP transfersget
Create a RTP transferpost
RTP Credit Transfer
RTP RfP Presentments
Delete a RTP RfP presentmentdelete
Retrieve a RTP RfP presentmentget
Retrieve RTP RfP presentmentsget
Create a RTP RfP presentmentpost
RTP RfP Presentment
RTP RfPs
Update a RTP RfPput
Retrieve a RTP RfPget
Retrieve RTP RfPsget
Create a RTP RfPpost
Request For Payment (RfP)
Web Hooks
Delete a Web Hookdelete
Update a web hookput
Retrieve a web hookget
Retrieve Web Hooksget
Create Web Hookpost
Usage
States
RTP/FedNow System Codes

Trice Auth API
Build
Retrieve buildget
Authentication
Create a tokenpost

201New web hook response OK

400Bad request

401Unauthorized

404Not found

502Bad gateway

defaultError