Lithic · Schema

Create Book Transfer Request

FinTechBaaSCard IssuingPaymentsEmbedded Finance

Properties

Name	Type	Description
amount	integer	Amount to be transferred in the currency's smallest unit (e.g., cents for USD). This should always be a positive value.
category	object
from_financial_account_token	string	Globally unique identifier for the financial account or card that will send the funds. Accepted type dependent on the program's use case.
memo	string	Optional descriptor for the transfer.
subtype	string	The program specific subtype code for the specified category/type.
to_financial_account_token	string	Globally unique identifier for the financial account or card that will receive the funds. Accepted type dependent on the program's use case.
token	string	Customer-provided token that will serve as an idempotency token. This token will become the transaction token.
type	object
external_id	string	External ID defined by the customer
on_closed_account	object
hold_token	string	Token of an existing hold to settle when this transfer is initiated

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/create_book_transfer_request",
  "title": "Create Book Transfer Request",
  "type": "object",
  "properties": {
    "amount": {
      "description": "Amount to be transferred in the currency's smallest unit (e.g., cents for USD). This should always be a positive value.",
      "type": "integer",
      "minimum": 1
    },
    "category": {
      "$ref": "#/components/schemas/book_transfer_category"
    },
    "from_financial_account_token": {
      "description": "Globally unique identifier for the financial account or card that will send the funds. Accepted type dependent on the program's use case.",
      "format": "uuid",
      "type": "string"
    },
    "memo": {
      "description": "Optional descriptor for the transfer.",
      "type": "string",
      "maxLength": 512
    },
    "subtype": {
      "description": "The program specific subtype code for the specified category/type.",
      "type": "string"
    },
    "to_financial_account_token": {
      "description": "Globally unique identifier for the financial account or card that will receive the funds. Accepted type dependent on the program's use case.",
      "format": "uuid",
      "type": "string"
    },
    "token": {
      "description": "Customer-provided token that will serve as an idempotency token. This token will become the transaction token.",
      "format": "uuid",
      "type": "string"
    },
    "type": {
      "$ref": "#/components/schemas/book_transfer_type"
    },
    "external_id": {
      "description": "External ID defined by the customer",
      "type": "string"
    },
    "on_closed_account": {
      "$ref": "#/components/schemas/on_closed_account"
    },
    "hold_token": {
      "description": "Token of an existing hold to settle when this transfer is initiated",
      "format": "uuid",
      "type": "string"
    }
  },
  "required": [
    "amount",
    "category",
    "from_financial_account_token",
    "subtype",
    "to_financial_account_token",
    "type"
  ]
}