PATCH
/
network_transfer
/
{id}
curl --request PATCH \
  --url https://api.treasuryprime.com/network_transfer/{id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "userdata": {
    "ok": "true"
  }
}'
{
  "amount": "100.00",
  "created_at": "2017-11-02T11:55:14Z",
  "cross_bank": true,
  "description": "Transfer",
  "estimated_settlement_at": "2017-11-02T11:55:14Z",
  "from_account_id": "acct_1234567890",
  "id": "nt_1029384756",
  "status": "pending",
  "to_account_id": "acct_0987654321",
  "updated_at": "2017-11-02T11:55:14Z",
  "userdata": {
    "ok": "true"
  }
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

​
id
string
required

Unique identifier for object

Body

application/json
The network_transfer to update
​
userdata
object

Arbitrary data the user can attach to the object

Response

200 - application/json
The network_transfer updated
​
amount
string

Amount of money to transfer, with two decimal precision

​
balanced_at
string

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

​
bankdata
object

Optional arbitrary data the bank can attach to the object

​
cross_bank
boolean

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.

​
description
string

Optional description (maximum of 10 characters)

​
error
string

Error message describing why a transfer failed

​
estimated_settlement_at
string

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_id
string

ID of the Account originating the transfer. Filterable.

​
id
string

Unique identifier for object

​
org_id
string

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

​
status
string

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

​
to_account_id
string

ID of the Account receiving the transfer. Filterable.

​
userdata
object

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

​
version
string

The API version used to create the network transfer