API Reference

Create an RTP, FedNow, or ACH transfer

post
https://api-sandbox.trice.co/hub/v1/smart_transfer

Creates a new rtp or fednow transfer

Body Params

Smart transfer body

int64
required
≥ 0

The transfer amount.

uuid
required

The unique ID (RFC-4122 UUID) of the bank account enrollment to use in conjunction with this tranfer.

string
length ≤ 10

This field is used to add specific entry descriptions to the transfer. For example it could contain any of these: ACCTVERIFY for micro-entries (the amount must be greater than 0 and less than 100 to use this), PAYROLL, payout, Gas bill, ins. prem., Soc. Sec., DTC, Trade Pay, PURCHASE, etc.

string
length ≤ 250

Up to 250 chars of additional information about the transaction only visible to you.

string
length ≤ 140

Up to 140 chars of additional information about the transaction shared with the receiver (FedNOW and RTP only).

network_deny_list
array of strings

If supplied the the array of values represents networks to omit from smart routing. Values can be rtp, fednow, ach_same_day and ach

network_deny_list
network_priority_list
array of strings

If supplied the the array of values represents network order of priority for smart routing. If not supplied the RTP network will be prioritized first, fednow second, ach_same_day third, and ach forth. Values can be rtp, fednow, ach_same_day and ach

network_priority_list
new_party
object

New party details

new_ultimate_receiving_party
object

New ultimate receiving party details

uuid

The unique ID (RFC-4122 UUID) of the party that the funds are being transfered to.

string
length ≤ 35

Up to 35 chars of reference data about the transaction. If this is left undefined, the network will populate this field.

string
enum

The type Standard Entry Class code for an ACH credit transfer. Required if ACH is used. CCD (Corporate Credit or Debit) for both debit or credit types, CIE (Customer Initiated) for only credit types, CTX (Corporate Trade Exchange) for both debit or credit types, IAT (International ACH Transaction) for both debit or credit types, MTE (Machine Transfer) for both debit or credit types, POS (Point of Sale) for both debit or credit types, PPD (Prearranged Payment and Deposit) for both debit or credit types, SHR (Shared Network Transaction) for both debit or credit types, WEB (Internet Initiated/Mobile) for both debit or credit types.

uuid

The unique ID (RFC-4122 UUID) of the account whos data will be used to send the transfer.. This is only usable if the account ID is a descendant the account that is creating this transfer.

uuid

The unique ID (RFC-4122 UUID) of the party that the funds are ultimately being transfered to. This field is informational and used by the receiver to account for the final destination of the funds.

uuid

The unique ID (RFC-4122 UUID) of the party that the funds are ultimately being transfered from. This party must be associated with the account that the enrollment is associated with. This is only usable if the account has the intermediary_rtp_v_2_9 or intermediary_rtp_v_3_0 capability activated.

Headers
uuid

A key used to manage the response in the case of a duplicate request. If a response with the same key already exists, then the previous response will be echoed.

integer
0 to 30000

The amount of time in milliseconds to wait on a final status response. If this header is provided, the system will block until either the status is updated to a final response or the time value is exceeded. If the time value is exceeded, then the X-TRICE-WAIT-FOR header will be included in the response with the time in milliseconds that elapsed on the system. Note that this time may be longer than the initial header value because the system will always execute until the message is send to the network. If the time value submitted in the header is 0, then the system will block until there is a final response or the maximum system timeout of 30 seconds is reached.

boolean

Setting this will run the execute all of the prechecks of creating the transfer but will not create it. If there is an error, a 400 response will return.

uuid

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

Responses

Updated 5 months ago

Language
Credentials
Bearer
JWT
Response 
Click Try It! to start a request and see the response here! Or choose an example:
*/*
application/json
Updated 5 months ago