Create an internal transfer

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

Creates an internal transfer

Responses

Response body

object

amount

int64

≥ 0

Amount in cents to be transfered.

amount_reversed

int64

≥ 0

Amount in cents reversed (can be less than the amount attribute on the transfer if a partial reversal was issued).

created

string

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

description

string | null

An arbitrary string attached to the transfer. Often useful for displaying to users.

destination_account

object | null

The account associated with the destination_enrollment. If this is null the destination enrollment and the enrollment are associated with the same account.

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.

destination_enrollment

object

The bank account enrollment that the transfer was sent to.

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.

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.

uuid

Unique transfer id (RFC-4122 UUID).

reversals

object | null

An object containing a list of the associated transfer reversals.

data

array of objects or null

The list contains transfer refersals associated with this transfer.

data

object | null

amount

int64

≥ 0

Amount in cents to be reversed.

created

string

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

description

string | null

An arbitrary string attached to the reversal. Often useful for displaying to users.

uuid

Unique transfer reversal id (RFC-4122 UUID).

has_more

boolean

True if this list has another page of items after this one that can be fetched.

object

string

A string describing the object type returned.

url

string

The URL where this list can be accessed.

reversed

boolean

Whether the transfer has been fully reversed. If the transfer is only partially reversed, this attribute will still be false.

Language

Credentials

Bearer

JWT


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

400Bad request

401Unauthorized

404Not found

502Bad gateway

defaultError