Book Transfers

Book Transfers

Last updated: (timestamp)

Book Transfers

book_transfers

Methods

Create book transfer

post/v1/book_transfers

Book transfer funds between two financial accounts or between a financial account and card

Get book transfer by token

get/v1/book_transfers/{book_transfer_token}

Get book transfer by token

List book transfers

get/v1/book_transfers

List book transfers

Reverse book transfer

post/v1/book_transfers/{book_transfer_token}/reverse

Reverse a book transfer

Domain Types

Book Transfer Response

BookTransferResponseobject

ShowShow

tokenstring

Customer-provided token that will serve as an idempotency token. This token will become the transaction token.

formatuuid

categoryenum

Accepts one of the following: "ADJUSTMENT", "BALANCE_OR_FUNDING", "DERECOGNITION", 4 more

Category of the book transfer

Hide ParametersShow Parameters

"ADJUSTMENT"

"BALANCE_OR_FUNDING"

"DERECOGNITION"

"DISPUTE"

"FEE"

"REWARD"

"TRANSFER"

createdstring

Date and time when the transfer occurred. UTC time zone.

formatdate-time

currencystring

3-character alphabetic ISO 4217 code for the settling currency of the transaction.

eventsarray of object

A list of all financial events that have modified this transfer.

Hide ParametersShow Parameters

tokenstring

Globally unique identifier.

formatuuid

amountnumber

Amount of the financial event that has been settled in the currency's smallest unit (e.g., cents).

createdstring

Date and time when the financial event occurred. UTC time zone.

formatdate-time

detailed_resultsarray of enum

Detailed Results

Hide ParametersShow Parameters

"APPROVED"

"FUNDS_INSUFFICIENT"

memostring

Memo for the transfer.

resultenum

Accepts one of the following: "APPROVED", "DECLINED"

APPROVED financial events were successful while DECLINED financial events were declined by user, Lithic, or the network.

Hide ParametersShow Parameters

"APPROVED"

"DECLINED"

subtypestring

The program specific subtype code for the specified category/type.

typestring

Type of the book transfer

from_financial_account_tokenstring

Globally unique identifier for the financial account or card that will send the funds. Accepted type dependent on the program's use case.

formatuuid

pending_amountnumber

Pending amount of the transaction in the currency's smallest unit (e.g., cents), including any acquirer fees. The value of this field will go to zero over time once the financial transaction is settled.

resultenum

Accepts one of the following: "APPROVED", "DECLINED"

APPROVED transactions were successful while DECLINED transactions were declined by user, Lithic, or the network.

Hide ParametersShow Parameters

"APPROVED"

"DECLINED"

settled_amountnumber

Amount of the transaction that has been settled in the currency's smallest unit (e.g., cents).

statusenum

Accepts one of the following: "DECLINED", "REVERSED", "SETTLED"

Status types: * DECLINED - The transfer was declined. * REVERSED - The transfer was reversed * SETTLED - The transfer is completed.

Hide ParametersShow Parameters

"DECLINED"

"REVERSED"

"SETTLED"

to_financial_account_tokenunknown

Globally unique identifier for the financial account or card that will receive the funds. Accepted type dependent on the program's use case.

updatedstring

Date and time when the financial transaction was last updated. UTC time zone.

formatdate-time