Create v2 Network Transfer - Treasury Prime Developer Documentation

Introduction

Account

Account Opening

Cards

Payments

Testing

Utilities

POST

network_transfer

curl --request POST \
  --url https://api.treasuryprime.com/v2/network_transfer \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": "100.00",
  "description": "Transfer",
  "from_account_id": "acct_1234567890",
  "to_account_id": "acct_0987654321"
}'

{
  "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": null
}

Authorizations

Authorization

string

header

required

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

Body

application/json

The v2_network_transfer to create

amount

string

required

Amount of money to transfer, with two decimal precision

from_account_id

string

required

ID of the Account originating the transfer. Filterable.

to_account_id

string

required

ID of the Account receiving the transfer. Filterable.

bankdata

object

Optional arbitrary data the bank can attach to the object

description

string

status

string

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

userdata

object

Optional arbitrary data that can be attached to the object

Response

200 - application/json

The v2_network_transfer created

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

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.

string

Unique identifier for object

org_id

string

ID of the organization with which the 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 to the object

version

string

The API version used to create the network transfer

Update a Network Transfer List Wire Transfers

curl --request POST \
  --url https://api.treasuryprime.com/v2/network_transfer \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": "100.00",
  "description": "Transfer",
  "from_account_id": "acct_1234567890",
  "to_account_id": "acct_0987654321"
}'

{
  "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": null
}