Skip to content
Stainless Stainless Stainless SDKs

Create

Create book transfer
post/v1/book_transfers

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

Body Parameters
amountnumber

Amount to be transferred in the currency’s smallest unit (e.g., cents for USD). This should always be a positive value.

minimum1
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"
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
subtypestring

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

to_financial_account_tokenstring

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

formatuuid
typeenum
Accepts one of the following: "ATM_WITHDRAWAL", "ATM_DECLINE", "INTERNATIONAL_ATM_WITHDRAWAL", 30 more

Type of book_transfer

Hide ParametersShow Parameters
"ATM_WITHDRAWAL"
"ATM_DECLINE"
"INTERNATIONAL_ATM_WITHDRAWAL"
"INACTIVITY"
"STATEMENT"
"MONTHLY"
"QUARTERLY"
"ANNUAL"
"CUSTOMER_SERVICE"
"ACCOUNT_MAINTENANCE"
"ACCOUNT_ACTIVATION"
"ACCOUNT_CLOSURE"
"CARD_REPLACEMENT"
"CARD_DELIVERY"
"CARD_CREATE"
"CURRENCY_CONVERSION"
"INTEREST"
"LATE_PAYMENT"
"BILL_PAYMENT"
"CASH_BACK"
"ACCOUNT_TO_ACCOUNT"
"CARD_TO_CARD"
"DISBURSE"
"BILLING_ERROR"
"LOSS_WRITE_OFF"
"EXPIRED_CARD"
"EARLY_DERECOGNITION"
"ESCHEATMENT"
"INACTIVITY_FEE_DOWN"
"PROVISIONAL_CREDIT"
"DISPUTE_WON"
"SERVICE"
"TRANSFER"
tokenstring
optional

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

formatuuid
memostring
optional

Optional descriptor for the transfer.

maxLength512
Returns
tokenstringcategoryenumcreatedstringcurrencystringeventsarray of objectfrom_financial_account_tokenstringpending_amountnumberresultenumsettled_amountnumberstatusenumto_financial_account_tokenunknownupdatedstringBookTransferResponse
Request example Request
curl https://api.lithic.com/v1/book_transfers \
    -H 'Content-Type: application/json' \
    -H "Authorization: $LITHIC_API_KEY" \
    -d '{
      "amount": 1,
      "category": "ADJUSTMENT",
      "from_financial_account_token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "subtype": "subtype",
      "to_financial_account_token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "type": "ATM_WITHDRAWAL"
    }'
200 Example
{
  "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"
}