POST
/
book
Create a Book Transfer
curl --request POST \
  --url https://api.treasuryprime.com/book \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": "100.00",
  "from_account_id": "acct_1234567890",
  "to_account_id": "acct_0987654321"
}'
{
  "amount": "100.00",
  "created_at": "2017-11-02T11:55:14Z",
  "description": null,
  "from_account_id": "acct_1234567890",
  "id": "book_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 book 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.

​
description
string

Optional description. Long descriptions may be truncated on legacy banking cores.

​
userdata
object

Arbitrary data the user can attach to the object

Response

200 - application/json

The book created

​
amount
string

Amount of money to transfer, with two decimal precision

​
bank_id
string

ID of the bank with which the object is associated

​
bankdata
object

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

​
description
string

Optional description. Long descriptions may be truncated on legacy banking cores.

​
error
string

Error message describing why a book transfer failed to send

​
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 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

Arbitrary data the user can attach to the object