Lithic API Documentation | Book Transfers

Book Transfers

book_transfers

Methods

List Book Transfers -> CursorPage<

BookTransferResponse

get/v1/book_transfers

List book transfers

query Parameters

account_token: string

Optional

(format: uuid)

begin: string

Optional

(format: date-time)

Date string in RFC 3339 format. Only entries created after the specified time will be included. UTC time zone.

business_account_token: string

Optional

(format: uuid)

category:

Optional

Book Transfer category to be returned.

"ADJUSTMENT"

"BALANCE_OR_FUNDING"

"DERECOGNITION"

"DISPUTE"

"FEE"

"INTERNAL"

"REWARD"

"PROGRAM_FUNDING"

"TRANSFER"

end: string

Optional

(format: date-time)

Date string in RFC 3339 format. Only entries created before the specified time will be included. UTC time zone.

ending_before: string

Optional

A cursor representing an item's token before which a page of results should end. Used to retrieve the previous page of results before this item.

financial_account_token: string

Optional

(format: uuid)

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

page_size: number

Optional

(maximum: 100, minimum: 1, default: 50)

Page size (for pagination).

result:

Optional

Book transfer result to be returned.

"APPROVED"

"DECLINED"

starting_after: string

Optional

A cursor representing an item's token after which a page of results should begin. Used to retrieve the next page of results after this item.

status:

Optional

Book transfer status to be returned.

"DECLINED"

"SETTLED"

Response fields

data: Array<

BookTransferResponse

has_more: boolean

Request example

curl https://api.lithic.com/v1/book_transfers \
    -H "Authorization: $LITHIC_API_KEY"

200Example

{
  "data": [
    {
      "token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "category": "ADJUSTMENT",
      "created": "2019-12-27T18:11:19.117Z",
      "currency": "USD",
      "events": [
        {
          "token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "amount": 0,
          "created": "2019-12-27T18:11:19.117Z",
          "detailed_results": [
            "APPROVED"
          ],
          "memo": "memo",
          "result": "APPROVED",
          "subtype": "subtype",
          "type": "ATM_BALANCE_INQUIRY"
        }
      ],
      "family": "TRANSFER",
      "from_financial_account_token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "pending_amount": 1000,
      "result": "APPROVED",
      "settled_amount": 500,
      "status": "PENDING",
      "to_financial_account_token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "updated": "2019-12-27T18:11:19.117Z",
      "external_id": "external_id",
      "external_resource": {
        "external_resource_token": "external_resource_token",
        "external_resource_type": "STATEMENT",
        "external_resource_sub_token": "external_resource_sub_token"
      },
      "transaction_series": {
        "related_transaction_event_token": "123e4567-e89b-12d3-a456-426614174000",
        "related_transaction_token": "123e4567-e89b-12d3-a456-426614174000",
        "type": "FEE"
      }
    }
  ],
  "has_more": true
}

Create Book Transfer ->

BookTransferResponse

post/v1/book_transfers

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

Get Book Transfer By Token ->

BookTransferResponse

get/v1/book_transfers/{book_transfer_token}

Get book transfer by token

Reverse Book Transfer ->

BookTransferResponse

post/v1/book_transfers/{book_transfer_token}/reverse

Reverse a book transfer

Retry Book Transfer ->

BookTransferResponse

post/v1/book_transfers/{book_transfer_token}/retry

Retry a book transfer that has been declined

Domain types

BookTransferResponse = { token, category, created, 13 more... }

Book transfer transaction