book_transfer_token

uuid

• required: Id of the book transfer to retrieve

``200 OK`

object

Base class for all transaction types in the ledger service

• status: string, enum, required

  • The status of the transaction
    PENDING, SETTLED, DECLINED, REVERSED, CANCELED, RETURNED

• token: uuid, required

  • Unique identifier for the transaction

• created: date-time, required

  • ISO 8601 timestamp of when the transaction was created

• updated: date-time, required

  • ISO 8601 timestamp of when the transaction was last updated

• family: const, enum, required

  • TRANSFER - Book Transfer Transaction
    TRANSFER

• result: string, enum, required
  APPROVED, DECLINED

• category: string, enum, required
  ADJUSTMENT, BALANCE_OR_FUNDING, DERECOGNITION, DISPUTE, FEE, INTERNAL, REWARD, PROGRAM_FUNDING, TRANSFER

• currency: string, required

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

• settled_amount: integer, required

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

• pending_amount: integer, required

  • 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.

• events: array of objects, required

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

events*

object

• amount: integer, required

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

• type: string, enum, required
  Type of the book transfer
  ATM_BALANCE_INQUIRY, 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, PAYMENT_FEE, 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, COLLECTION

• result: string, enum, required

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

• created: date-time, required

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

• token: uuid, required

  • Globally unique identifier.

• subtype: string, required

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

• memo: string, required

  • Memo for the transfer.

• detailed_results: array of objects, required

  • APPROVED, FUNDS_INSUFFICIENT

• from_financial_account_token: uuid, required

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

• to_financial_account_token: uuid, required

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

• external_id: string, null

  • External ID defined by the customer

• transaction_series:

  • A series of transactions that are grouped together
  • Transaction Series: null, Transaction Series object

• external_resource:

  • An external resource associated with the transfer
  • ExternalResource: null, ExternalResource object

``400 A parameter in the query given in the request does not match the valid queries for the endpoint.

``401 | | | | --- | --- | | User has not been authenticated | Invalid or missing API key | | API key is not active | The API key used is no longer active | | Could not find API key | The API key provided is not associated with any user | | Please provide API key in Authorization header | The Authorization header is not in the request | | Please provide API key in the form Authorization: [api-key] | The Authorization header is not formatted properly | | Insufficient privileges. Issuing API key required | Write access requires an Issuing API key. Reach out at lithic.com/contact | | Insufficient privileges to create virtual cards. | Creating virtual cards requires an additional privilege |

``404 The specified resource was not found.

``429 Client has exceeded the number of allowed requests in a given time period. | | | | --- | --- | | Rate limited, too many requests per second | User has exceeded their per second rate limit | | Rate limited, reached daily limit | User has exceeded their daily rate limit | | Rate limited, too many keys tried | One IP has queried too many different API keys |

Updated 3 months ago

ShellNodeRubyPHPPython

curl --request GET \
     --url https://sandbox.lithic.com/v1/book_transfers/book_transfer_token \
     --header 'accept: application/json'

{
  "status": "PENDING",
  "token": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "created": "2026-07-18T00:25:14.517Z",
  "updated": "2026-07-18T00:25:14.517Z",
  "family": "string",
  "result": "APPROVED",
  "category": "ADJUSTMENT",
  "currency": "USD",
  "settled_amount": 500,
  "pending_amount": 1000,
  "events": [
    {
      "amount": 0,
      "type": "ATM_BALANCE_INQUIRY",
      "result": "APPROVED",
      "created": "2026-07-18T00:25:14.517Z",
      "token": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "subtype": "string",
      "memo": "string",
      "detailed_results": [
        "APPROVED"
      ]
    }
  ],
  "from_financial_account_token": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "to_financial_account_token": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "external_id": "string",
  "transaction_series": {
    "type": "FEE",
    "related_transaction_token": "123e4567-e89b-12d3-a456-426614174000",
    "related_transaction_event_token": "123e4567-e89b-12d3-a456-426614174000"
  },
  "external_resource": {
    "external_resource_type": "STATEMENT",
    "external_resource_token": "string",
    "external_resource_sub_token": "string"
  }
}

Updated 3 months ago