API Reference

Create a FedNow transfer

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

Creates a new fednow transfer

Body Params

Fednow transfers body

int64
required
≥ 0

The transfer amount.

string
length ≤ 8

Up to 8 alpha-numberic digits that will be added to the statement description.

uuid
required

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

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. This field is also concatinated onto the end of the sender field.

uuid
required

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

boolean

If true then the code field will be prepended to the statement description followed by a hyphen (-), otherwise the code field will be appended to the statement description after a hyphen (-).

string
length ≤ 35

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

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_fednow_v_2_9 or intermediary_fednow_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 of rejected, failed, timed_out, completed or the time value is exceeded. If the time value is matched or exceeded, then the X-TRICE-WAIT-FOR header will be included in the response with the time in milliseconds that elapsed on the system, otherwise the response header will be omitted. 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