Skip to content
Stainless Stainless Stainless SDKs

Transfers

Transfers

Last updated: (timestamp)

Transfers

transfers
Methods
Transfer funds within Lithic
post/v1/transfer

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

Domain Types
Transfer
Transferobject
ShowShow
tokenstring
optional

Globally unique identifier for the transfer event.

formatuuid
categoryenum
optional
Accepts one of the following: "TRANSFER"

Status types:

  • TRANSFER - Internal transfer of funds between financial accounts in your program.
Hide ParametersShow Parameters
"TRANSFER"
createdstring
optional

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

formatdate-time
currencystring
optional

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

descriptorstring
optional

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

eventsarray of object
optional

A list of all financial events that have modified this trasnfer.

Hide ParametersShow Parameters
tokenstring
optional

Globally unique identifier.

formatuuid
amountnumber
optional

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

createdstring
optional

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

formatdate-time
resultenum
optional
Accepts one of the following: "APPROVED", "DECLINED"

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

Hide ParametersShow Parameters
"APPROVED"
"DECLINED"
typeenum
optional
Accepts one of the following: "ACH_ORIGINATION_CANCELLED", "ACH_ORIGINATION_INITIATED", "ACH_ORIGINATION_PROCESSED", 65 more
Hide ParametersShow Parameters
"ACH_ORIGINATION_CANCELLED"
"ACH_ORIGINATION_INITIATED"
"ACH_ORIGINATION_PROCESSED"
"ACH_ORIGINATION_RELEASED"
"ACH_ORIGINATION_REVIEWED"
"ACH_ORIGINATION_SETTLED"
"ACH_RECEIPT_PROCESSED"
"ACH_RECEIPT_SETTLED"
"ACH_RETURN_INITIATED"
"ACH_RETURN_PROCESSED"
"ACH_RETURN_SETTLED"
"AUTHORIZATION"
"AUTHORIZATION_ADVICE"
"AUTHORIZATION_EXPIRY"
"AUTHORIZATION_REVERSAL"
"BALANCE_INQUIRY"
"BILLING_ERROR"
"BILLING_ERROR_REVERSAL"
"CARD_TO_CARD"
"CASH_BACK"
"CASH_BACK_REVERSAL"
"CLEARING"
"COLLECTION"
"CORRECTION_CREDIT"
"CORRECTION_DEBIT"
"CREDIT_AUTHORIZATION"
"CREDIT_AUTHORIZATION_ADVICE"
"CURRENCY_CONVERSION"
"CURRENCY_CONVERSION_REVERSAL"
"DISPUTE_WON"
"EXTERNAL_ACH_CANCELED"
"EXTERNAL_ACH_INITIATED"
"EXTERNAL_ACH_RELEASED"
"EXTERNAL_ACH_REVERSED"
"EXTERNAL_ACH_SETTLED"
"EXTERNAL_CHECK_CANCELED"
"EXTERNAL_CHECK_INITIATED"
"EXTERNAL_CHECK_RELEASED"
"EXTERNAL_CHECK_REVERSED"
"EXTERNAL_CHECK_SETTLED"
"EXTERNAL_TRANSFER_CANCELED"
"EXTERNAL_TRANSFER_INITIATED"
"EXTERNAL_TRANSFER_RELEASED"
"EXTERNAL_TRANSFER_REVERSED"
"EXTERNAL_TRANSFER_SETTLED"
"EXTERNAL_WIRE_CANCELED"
"EXTERNAL_WIRE_INITIATED"
"EXTERNAL_WIRE_RELEASED"
"EXTERNAL_WIRE_REVERSED"
"EXTERNAL_WIRE_SETTLED"
"FINANCIAL_AUTHORIZATION"
"FINANCIAL_CREDIT_AUTHORIZATION"
"INTEREST"
"INTEREST_REVERSAL"
"INTERNAL_ADJUSTMENT"
"LATE_PAYMENT"
"LATE_PAYMENT_REVERSAL"
"LOSS_WRITE_OFF"
"PROVISIONAL_CREDIT"
"PROVISIONAL_CREDIT_REVERSAL"
"SERVICE"
"RETURN"
"RETURN_REVERSAL"
"TRANSFER"
"TRANSFER_INSUFFICIENT_FUNDS"
"RETURNED_PAYMENT"
"RETURNED_PAYMENT_REVERSAL"
"LITHIC_NETWORK_PAYMENT"
from_balancearray of available_amountnumbercreatedstringcurrencystringfinancial_account_tokenstringfinancial_account_typeenumlast_transaction_event_tokenstringlast_transaction_tokenstringpending_amountnumbertotal_amountnumberupdatedstringBalance
optional

The updated balance of the sending financial account.

pending_amountnumber
optional

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.

resultenum
optional
Accepts one of the following: "APPROVED", "DECLINED"

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

Hide ParametersShow Parameters
"APPROVED"
"DECLINED"
settled_amountnumber
optional

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

statusenum
optional
Accepts one of the following: "DECLINED", "EXPIRED", "PENDING", 2 more

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.
Hide ParametersShow Parameters
"DECLINED"
"EXPIRED"
"PENDING"
"SETTLED"
"VOIDED"
to_balancearray of available_amountnumbercreatedstringcurrencystringfinancial_account_tokenstringfinancial_account_typeenumlast_transaction_event_tokenstringlast_transaction_tokenstringpending_amountnumbertotal_amountnumberupdatedstringBalance
optional

The updated balance of the receiving financial account.

updatedstring
optional

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

formatdate-time