Lithic API Documentation | Book Transfers

Book Transfers

book_transfers

Methods

List Book Transfers -> CursorPage<

BookTransferResponse

get/v1/book_transfers

List book transfers

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

path Parameters

book_transfer_token: string

(format: uuid)

Response fields

BookTransferResponse

Request example

curl https://api.lithic.com/v1/book_transfers/$BOOK_TRANSFER_TOKEN/retry \
    -H 'Content-Type: application/json' \
    -H "Authorization: $LITHIC_API_KEY" \
    -d '{
          "retry_token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
        }'

200Example

{
  "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"
  }
}

Domain types

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

Book transfer transaction