Sign in

v1

latestOpenAPI 3.1.02026-07-261520561.4 KB
Book Transfer

Fetch a Book Transfer

get/book/{id}

Path parameters

idstring required

Unique identifier for object

Unique identifier for object

Response

The book

amountstring

Amount of money to transfer, with two decimal precision

bank_idstring

ID of the bank with which the object is associated

bankdataobject

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

descriptionstring

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

errorstring

Error message describing why a book transfer failed to send

from_account_idstring

ID of the account originating the transfer. Filterable.

idstring

Unique identifier for object

org_idstring

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

Arbitrary data the user can attach to the object