Create book transfer

post

https://sandbox.lithic.com/v1/book_transfers

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

Body Params

amount

integer

required

≥ 1

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

category

string

enum

required

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.

memo

string

length ≤ 512

Optional descriptor for the transfer.

subtype

string

required

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

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.

token

uuid

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

type

string

enum

required

Type of the book transfer

external_id

string

External ID defined by the customer

on_closed_account

string

enum

Defaults to FAIL

What to do if the financial account is closed when posting an operation

Allowed:

hold_token

uuid

Token of an existing hold to settle when this transfer is initiated

Responses


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


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

200OK

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

404The specified resource was not found.