Create an RTP or FedNow transfer

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

Creates a new rtp or fednow transfer

Body Params

Smart transfer body

amount

int64

required

≥ 0

The transfer amount.

enrollment

uuid

required

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

internal_description

string

length ≤ 250

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

memo

string

length ≤ 140

Up to 140 chars of additional information about the transaction shared with the receiver.

network_deny_list

array of strings

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

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. Values can be rtp and fednow

network_priority_list

new_party

object

New party details

new_ultimate_receiving_party

object

New ultimate receiving party details

party

uuid

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

reference_number

string

length ≤ 35

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

sender

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.

ultimate_receiving_party

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.

ultimate_sending_party

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

X-TRICE-WAIT-FOR

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.

X-TRICE-ACCOUNT

uuid

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

Responses

Response body

object

fednow_transfer

object | null

FedNow transfer details

amount

int64

≥ 0

The transfer amount.

completed

string | null

Formatted timestamp (YYYY-MM-DD HH:MM:SS) determining when the real time payment transfer was completed.

created

string

Formatted timestamp (YYYY-MM-DD HH:MM:SS) determining when the real time payment transfer was created.

enrollment

object

The bank account enrollment to use in conjunction with this transfer.

fee

int64

≥ 0

The real time payment transfer processing fee.

uuid

Unique real time payment transfer id (RFC-4122 UUID).

internal_description

string | null

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

memo

string | null

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.

party

object | null

The entity that the funds are being transfered to or from.

reference_number

string | null

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

returned

object | null

The details surrounding the transfer return.

sender

object | null

The account whos data will be used to send the transfer. If this is null the data of the account associated with this transfer will be used.

state_details

object | null

If present, contains the fednow transfer status data from the network.

status

string

Current status of the real time payment transfer: created, rejected, processing, failed, timed_out, finalizing, completed or returned.

An outbound credit transfer is: created if pre-checks are passed. Pre-checks may determine the transaction is rejected. When the transaction is sent to the network it is then processing. If the transaction fails network checks it will become failed. If the receiving participant failed to provide a response within the network SLA it will become timed_out. A transaction will be finalizing if the receiving financial institution accepts the transaction and then become completed when the funds are posted to the recipient. The status is set to returned if the transfer was returned.

An inbound credit transfer is: created when an incoming credit transfer is received from the network. It is rejected if Trice rejected the transaction. The transaction is processing when the accepted transaction is awaiting confirmation from the network. If the transaction fails network checks it will become failed. If the network does not receive a response from Trice within the network SLA it will become timed_out. A transaction will then be finalizing until it becomes completed and the funds are posted to the recipient. The status is set to returned if the transfer was returned.

created rejected processing failed timed_out finalizing completed returned

type

string

The type of credit transfer: outbound, inbound, outbound_from_rfp, or inbound_from_rfp. A transfer is outbound when sent from the account to an external party. A transfer is inbound when received by an account from an external party. A transfer is inbound_from_rfp if it was inbound as a result of a previous request for payment. A transfer is outbound_from_rfp if it was outbound as a result of a previous request for payment.

outbound inbound inbound_from_rfp outbound_from_rfp

ultimate_receiving_party

object | null

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.

ultimate_sending_party

object | null

The party that the funds are ultimately being transfered from.

report

array of objects or null

Smart transfer report details in network attempt order

report

object | null

errors

array of objects or null

The errors associated with the network status

errors

object | null

message

string

this is a descriptive error message

path

string

this is a path to the error for lookup

network

string

The network being reported on

rtp fednow

reason

string

describes the reason for the network status

status

string

individual network status related to the smart transfer

success failed omitted

rtp_transfer

object | null

RTP transfer details

amount

int64

≥ 0

The transfer amount.

completed

string | null

Formatted timestamp (YYYY-MM-DD HH:MM:SS) determining when the real time payment transfer was completed.

created

string

Formatted timestamp (YYYY-MM-DD HH:MM:SS) determining when the real time payment transfer was created.

enrollment

object

The bank account enrollment to use in conjunction with this transfer.

fee

int64

≥ 0

The real time payment transfer processing fee.

uuid

Unique real time payment transfer id (RFC-4122 UUID).

internal_description

string | null

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

memo

string | null

Up to 140 chars of additional information about the transaction shared with the receiver.

party

object | null

The entity that the funds are being transfered to or from.

reference_number

string | null

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

returned

object | null

The details surrounding the transfer return.

rtp_rfp_id

uuid | null

If this transfer is associate to a request for payment, this is the unique real time payment rfp id (RFC-4122 UUID).

sender

object | null

The account whos data will be used to send the transfer. If this is null the data of the account associated with this transfer will be used.

state_details

object | null

If present, contains the real time payment transfer status data from the network.

status

string

Current status of the real time payment transfer: created, rejected, processing, failed, timed_out, finalizing, completed or returned.

created rejected processing failed timed_out finalizing completed returned

type

string

outbound inbound inbound_from_rfp outbound_from_rfp

ultimate_receiving_party

object | null

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.

ultimate_sending_party

object | null

The party that the funds are ultimately being transfered from.

Language

Credentials

Bearer

JWT


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api-sandbox.trice.co/hub/v1/smart_transfer \
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

201New smart transfer response OK

400Bad request

401Unauthorized

404Not found

502Bad gateway

defaultError