Skip to content
Stainless Stainless Stainless SDKs

List

List book transfers
get/v1/book_transfers

List book transfers

Query Parameters
account_tokenstring
optional
formatuuid
beginstring
optional

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

formatdate-time
business_account_tokenstring
optional
formatuuid
categoryenum
optional
Accepts one of the following: "BALANCE_OR_FUNDING", "FEE", "REWARD", 4 more

Book Transfer category to be returned.

Hide ParametersShow Parameters
"BALANCE_OR_FUNDING"
"FEE"
"REWARD"
"ADJUSTMENT"
"DERECOGNITION"
"DISPUTE"
"INTERNAL"
endstring
optional

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

formatdate-time
ending_beforestring
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_tokenstring
optional

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

formatuuid
page_sizenumber
optional

Page size (for pagination).

maximum100
minimum1
resultenum
optional
Accepts one of the following: "APPROVED", "DECLINED"

Book transfer result to be returned.

Hide ParametersShow Parameters
"APPROVED"
"DECLINED"
starting_afterstring
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.

statusenum
optional
Accepts one of the following: "DECLINED", "SETTLED"

Book transfer status to be returned.

Hide ParametersShow Parameters
"DECLINED"
"SETTLED"
Returns
dataarray of tokenstringcategoryenumcreatedstringcurrencystringeventsarray of objectfrom_financial_account_tokenstringpending_amountnumberresultenumsettled_amountnumberstatusenumto_financial_account_tokenunknownupdatedstringBookTransferResponse
has_moreboolean
Request example Request
curl https://api.lithic.com/v1/book_transfers \
    -H "Authorization: $LITHIC_API_KEY"
200 Example
{
  "data": [
    {
      "token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "category": "ADJUSTMENT",
      "created": "2019-12-27T18:11:19.117Z",
      "currency": "currency",
      "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": "type"
        }
      ],
      "from_financial_account_token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "pending_amount": 0,
      "result": "APPROVED",
      "settled_amount": 0,
      "status": "DECLINED",
      "to_financial_account_token": {},
      "updated": "2019-12-27T18:11:19.117Z"
    }
  ],
  "has_more": true
}