Book Transfer

Transfer funds within Lithic

Changed on

Transfer funds between two financial accounts or between a financial account and card

post/v1/transfer

Request

  • Base URL
    https://sandbox.lithic.com
  • URL
    https://sandbox.lithic.com/v1/transfer
  • Auth
    API key in header Authorization

Request body

amountinteger required

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

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

memostring

Optional descriptor for the transfer.

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

tokenstring uuid

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

Response

OK

category'TRANSFER'

Status types:

  • TRANSFER - Internal transfer of funds between financial accounts in your program.
createdstring date-time

Date and time when the transfer occurred. UTC time zone.

currencystring

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

descriptorstring

A string that provides a description of the transfer; may be useful to display to users.

pending_amountinteger

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.

result'APPROVED' | 'DECLINED'

APPROVED transactions were successful while DECLINED transactions were declined by user, Lithic, or the network.

settled_amountinteger

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

status'DECLINED' | 'EXPIRED' | 'PENDING' | 'SETTLED' | 'VOIDED'

Status types:

  • DECLINED - The transfer was declined.
  • EXPIRED - The transfer was held in pending for too long and expired.
  • PENDING - The transfer is pending release from a hold.
  • SETTLED - The transfer is completed.
  • VOIDED - The transfer was reversed before it settled.
tokenstring uuid

Globally unique identifier for the transfer event.

updatedstring date-time

Date and time when the financial transaction was last updated. UTC time zone.

Example response

{
  "from_balance": [
    {
      "financial_account_token": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ],
  "to_balance": [
    {
      "financial_account_token": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ]
}

Changes

  • 9798275dc379Revision changes
    • warning

      added the new INSTANCE_TO_INSTANCE enum value to the // response property for the response status

    • warning

      added the new INTRA_BANK_CANCELED enum value to the // response property for the response status

    • warning

      added the new INTRA_BANK_INITIATED enum value to the // response property for the response status

    • warning

      added the new INTRA_BANK_SETTLED enum value to the // response property for the response status

  • dc3c4d014332Revision changes
    • warning

      added the new FEE enum value to the // response property for the response status

    • warning

      added the new FEE_REVERSAL enum value to the // response property for the response status