v1

latestOpenAPI 3.1.02026-07-261520561.4 KB

Network Transfer

Update a Network Transfer

patch/network_transfer/{id}

Path parameters

idstring required

Unique identifier for object

Request body

userdataobject

Arbitrary data the user can attach to the object

Response

The network_transfer updated

amountstring

Amount of money to transfer, with two decimal precision

balanced_atstring

Timestamp of when the balancing wire for the transfer was created/sent. Only present on v2 transfers.

bankdataobject

Optional arbitrary data the bank can attach to the object

cross_bankboolean

Identifies whether or not this transfer is between different banks. When true, Treasury Prime is explicitly directed to balance on-core funds between the two banks involved. Filterable.

descriptionstring

Optional description

errorstring

Error message describing why a transfer failed

estimated_settlement_atstring

Timestamp of when the network transfer is estimated to complete. This will be the current timestamp in all cases except when the Network Transfer is outside of the bank's operating hours. In this situation, the timestamp will be the next banking business day

from_account_idstring

ID of the Account originating the transfer. Filterable.

idstring

Unique identifier for object

org_idstring

ID of the organization with which this object is associated. Filterable.

statusstring

One of pending, canceled, sent, or error. Filterable.

to_account_idstring

ID of the Account receiving the transfer. Filterable.

userdataobject

Optional arbitrary data that can be attached for the bank's use

versionstring

The API version used to create the network transfer