Create a FedNow transfer

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

Creates a new fednow transfer

Body Params

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

party

uuid

required

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_fednow_v_2_9 or intermediary_fednow_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 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.

X-TRICE-ACCOUNT

uuid

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

Responses

Response body

object

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.

bank_id

string

The bank id of bank associated with the routing number.

bank_name

string

Name of bank associated with the routing number.

capabilities

object

A hash containing the set of capabilities that were requested for this account and their associated states. Keys are names of capabilities. Values may be active, inactive, or pending.

created

string

Formatted timestamp (YYYY-MM-DD HH:MM:SS) determining when the enrollment was created.

fednow_support

object

Federal Reserve FedNow network support.

uuid

Unique enrollment id (RFC-4122 UUID).

routing_number

string

ABA compliant routing number for the enrollment bank account.

rtp_support

object

The Clearing House RTP network support.

updated

string | null

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

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.

account_number

string | null

ABA compliant account number for receiving credit transfers. Only present if can_receive is true.

address

object | null

The physical address of the person or business that owns the bank account.

bank_details

object | null

The account holder bank details.

can_receive

boolean

If set to true the party can receive funds, if false funds will be rejected.

created

string

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

dob

object | null

If the party is an individual, this is the individual date of birth.

domestic

boolean | null

If set to true the party is domiciled in the united states, if false the party is domiciled outside the united states.

string | null

The email of the person or business that owns the bank account.

hold_details

object | null

If present, the party is unable to participate in transactions.

uuid

Unique party id (RFC-4122 UUID).

name

string | null

The name of the person or business that owns the bank account.

phone

object | null

The phone number of the person or business that owns the bank account.

status

string

Current status of the party: ok, on_hold. A party is ok if it has passed trice compliance checks. Some on_hold parties may initially show as ok but then change to on_hold.

ok on_hold

tax_id_provided

boolean

Whether the business ID number was provided.

type

string | null

The type of entity that holds the account. This can be either individual or business.

individual business

updated

string | null

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

verified

string | null

Formated timestamp (YYYY-MM-DD HH:MM:SS) determining when the party was last verified.

verified_for

array of objects or null

List of bank verifications for the party.

verified_for

object | null

bank_id

string

This represents the bank id that has been verified. Values can be transpecos_banks for TransPecos Banks, local_bank for Local Bank (sandbox)

bank_name

string

This represents the bank name that has been verified.

verified

string

Formatted timestamp (YYYY-MM-DD HH:MM:SS) determining when verification happened.

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.

amount

int64

≥ 0

The amount that was returned.

fednow_transfer_id

uuid

Associated transfer id (RFC-4122 UUID).

fee

int64

≥ 0

The transfer reversal processing fee.

message

string | null

More details about the return.

reason

string | null

The reason for the return.

timestamp

string

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

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.

account_number

string

ABA compliant account number for receiving credit transfers.

business

object | null

Information about the company or business. This field is available for any business_type.

business_profile

object | null

Business information about the account.

business_type

string | null

The business type. Possible values: company, non_profit, government_entity, individual

company non_profit government_entity individual

capabilities

object

A hash containing the set of capabilities that was requested for this account and their associated states. Keys are names of capabilities. Values may be active, inactive, or pending.

created

string

Formatted timestamp (YYYY-MM-DD HH:MM:SS) determining when the account was created.

string

length ≤ 100

Email address (RFC 822 characters).

enrollments

array of objects

DEPRECATED List of bank account enrollments for the account.

enrollments

object

bank_id

string

The bank id of bank associated with the routing number.

bank_name

string

Name of bank associated with the routing number.

capabilities

object

A hash containing the set of capabilities that were requested for this account and their associated states. Keys are names of capabilities. Values may be active, inactive, or pending.

created

string

Formatted timestamp (YYYY-MM-DD HH:MM:SS) determining when the enrollment was created.

fednow_support

object

Federal Reserve FedNow network support.

uuid

Unique enrollment id (RFC-4122 UUID).

routing_number

string

ABA compliant routing number for the enrollment bank account.

rtp_support

object

The Clearing House RTP network support.

updated

string | null

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

hold_details

object | null

If present, the account is unable to participate in transactions.

uuid

Unique account id (RFC-4122 UUID).

individual

object | null

Information about the person represented by the account. This field is null unless business_type is set to individual.

ip_address_allow_list

array of strings

List of ip addresses that are allowed to POST to the rtp_transfers and rtp_rfps endpoints.

ip_address_allow_list

status

string

Current status of the account: ok, on_hold. An account is ok if it has passed trice compliance checks. Some on_hold accounts may initially show as ok but then change to on_hold.

ok on_hold

tos_acceptance

object | null

Details on the acceptance of the TOS.

updated

string | null

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

verified

string | null

DEPRECATED Formated timestamp (YYYY-MM-DD HH:MM:SS) determining when the account was last verified.

verified_for

array of objects or null

List of bank verifications for the account.

verified_for

object | null

bank_id

string

This represents the bank id that has been verified. Values can be transpecos_banks for TransPecos Banks, local_bank for Local Bank (sandbox)

bank_name

string

This represents the bank name that has been verified.

verified

string

Formatted timestamp (YYYY-MM-DD HH:MM:SS) determining when verification happened.

state_details

object | null

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

message

string | null

More details about the current state.

reason

string | null

The reason description.

reason_code

string | null

The reason code that relates to the state.

timestamp

string

Formatted timestamp (YYYY-MM-DD HH:MM:SS) determining when state data was entered.

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.

account_number

string | null

ABA compliant account number for receiving credit transfers. Only present if can_receive is true.

address

object | null

The physical address of the person or business that owns the bank account.

bank_details

object | null

The account holder bank details.

can_receive

boolean

If set to true the party can receive funds, if false funds will be rejected.

created

string

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

dob

object | null

If the party is an individual, this is the individual date of birth.

domestic

boolean | null

If set to true the party is domiciled in the united states, if false the party is domiciled outside the united states.

string | null

The email of the person or business that owns the bank account.

hold_details

object | null

If present, the party is unable to participate in transactions.

uuid

Unique party id (RFC-4122 UUID).

name

string | null

The name of the person or business that owns the bank account.

phone

object | null

The phone number of the person or business that owns the bank account.

status

string

Current status of the party: ok, on_hold. A party is ok if it has passed trice compliance checks. Some on_hold parties may initially show as ok but then change to on_hold.

ok on_hold

tax_id_provided

boolean

Whether the business ID number was provided.

type

string | null

The type of entity that holds the account. This can be either individual or business.

individual business

updated

string | null

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

verified

string | null

Formated timestamp (YYYY-MM-DD HH:MM:SS) determining when the party was last verified.

verified_for

array of objects or null

List of bank verifications for the party.

verified_for

object | null

bank_id

string

This represents the bank id that has been verified. Values can be transpecos_banks for TransPecos Banks, local_bank for Local Bank (sandbox)

bank_name

string

This represents the bank name that has been verified.

verified

string

Formatted timestamp (YYYY-MM-DD HH:MM:SS) determining when verification happened.

ultimate_sending_party

object | null

The party that the funds are ultimately being transfered from.

account_number

string | null

ABA compliant account number for receiving credit transfers. Only present if can_receive is true.

address

object | null

The physical address of the person or business that owns the bank account.

bank_details

object | null

The account holder bank details.

can_receive

boolean

If set to true the party can receive funds, if false funds will be rejected.

created

string

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

dob

object | null

If the party is an individual, this is the individual date of birth.

domestic

boolean | null

If set to true the party is domiciled in the united states, if false the party is domiciled outside the united states.

string | null

The email of the person or business that owns the bank account.

hold_details

object | null

If present, the party is unable to participate in transactions.

uuid

Unique party id (RFC-4122 UUID).

name

string | null

The name of the person or business that owns the bank account.

phone

object | null

The phone number of the person or business that owns the bank account.

status

string

Current status of the party: ok, on_hold. A party is ok if it has passed trice compliance checks. Some on_hold parties may initially show as ok but then change to on_hold.

ok on_hold

tax_id_provided

boolean

Whether the business ID number was provided.

type

string | null

The type of entity that holds the account. This can be either individual or business.

individual business

updated

string | null

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

verified

string | null

Formated timestamp (YYYY-MM-DD HH:MM:SS) determining when the party was last verified.

verified_for

array of objects or null

List of bank verifications for the party.

verified_for

object | null

bank_id

string

This represents the bank id that has been verified. Values can be transpecos_banks for TransPecos Banks, local_bank for Local Bank (sandbox)

bank_name

string

This represents the bank name that has been verified.

verified

string

Formatted timestamp (YYYY-MM-DD HH:MM:SS) determining when verification happened.

Language

Credentials

Bearer

JWT


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

400Bad request

401Unauthorized

404Not found

502Bad gateway

defaultError