Payments

Payments

Last updated: (timestamp)

Payments

payments

Methods

Create payment

post/v1/payments

Initiates a payment between a financial account and an external bank account.

Get payment by token

get/v1/payments/{payment_token}

Get the payment by token.

List payments

get/v1/payments

List all the payments for the provided search criteria.

Retry payment

post/v1/payments/{payment_token}/retry

Retry an origination which has been returned.

Simulate payment lifecycle event

post/v1/simulate/payments/{payment_token}/action

Simulate payment lifecycle event

Simulate receipt

post/v1/simulate/payments/receipt

Simulates a receipt of a Payment.

Simulate release payment

post/v1/simulate/payments/release

Simulates a release of a Payment.

Simulate return payment

post/v1/simulate/payments/return

Simulates a return of a Payment.

Domain Types

Payment

Paymentobject

ShowShow

tokenstring

Globally unique identifier.

formatuuid

categoryenum

Accepts one of the following: "ACH"

Payment category

Hide ParametersShow Parameters

"ACH"

createdstring

Date and time when the payment first occurred. UTC time zone.

formatdate-time

currencystring

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

descriptorstring

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

directionenum

Accepts one of the following: "CREDIT", "DEBIT"

Hide ParametersShow Parameters

"CREDIT"

"DEBIT"

eventsarray of object

A list of all payment events that have modified this payment.

Hide ParametersShow Parameters

tokenstring

Globally unique identifier.

formatuuid

amountnumber

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

createdstring

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

formatdate-time

resultenum

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

Accepts one of the following: "ACH_ORIGINATION_CANCELLED", "ACH_ORIGINATION_INITIATED", "ACH_ORIGINATION_PROCESSED", 8 more

Event types:

• ACH_ORIGINATION_INITIATED - ACH origination received and pending approval/release from an ACH hold.
• ACH_ORIGINATION_REVIEWED - ACH origination has completed the review process.
• ACH_ORIGINATION_CANCELLED - ACH origination has been cancelled.
• ACH_ORIGINATION_PROCESSED - ACH origination has been processed and sent to the Federal Reserve.
• ACH_ORIGINATION_SETTLED - ACH origination has settled.
• ACH_ORIGINATION_RELEASED - ACH origination released from pending to available balance.
• ACH_RETURN_PROCESSED - ACH origination returned by the Receiving Depository Financial Institution.
• ACH_RECEIPT_PROCESSED - ACH receipt pending release from an ACH holder.
• ACH_RETURN_INITIATED - ACH initiated return for a ACH receipt.
• ACH_RECEIPT_SETTLED - ACH receipt funds have settled.
• ACH_RECEIPT_RELEASED - ACH receipt released from pending to available balance.
• ACH_RETURN_SETTLED - ACH receipt return settled by the Receiving Depository Financial Institution.

Hide ParametersShow Parameters

"ACH_ORIGINATION_CANCELLED"

"ACH_ORIGINATION_INITIATED"

"ACH_ORIGINATION_PROCESSED"

"ACH_ORIGINATION_SETTLED"

"ACH_ORIGINATION_RELEASED"

"ACH_ORIGINATION_REVIEWED"

"ACH_RECEIPT_PROCESSED"

"ACH_RECEIPT_SETTLED"

"ACH_RETURN_INITIATED"

"ACH_RETURN_PROCESSED"

"ACH_RETURN_SETTLED"

detailed_resultsarray of enum

optional

More detailed reasons for the event

Hide ParametersShow Parameters

"APPROVED"

"FUNDS_INSUFFICIENT"

"ACCOUNT_INVALID"

"PROGRAM_TRANSACTION_LIMIT_EXCEEDED"

"PROGRAM_DAILY_LIMIT_EXCEEDED"

"PROGRAM_MONTHLY_LIMIT_EXCEEDED"

external_bank_account_tokenstring

formatuuid

financial_account_tokenstring

formatuuid

methodenum

Accepts one of the following: "ACH_NEXT_DAY", "ACH_SAME_DAY"

Hide ParametersShow Parameters

"ACH_NEXT_DAY"

"ACH_SAME_DAY"

method_attributesobject

Hide ParametersShow Parameters

company_idstring

receipt_routing_numberstring

retriesnumber

return_reason_codestring

sec_codeenum

Accepts one of the following: "CCD", "PPD", "WEB"

Hide ParametersShow Parameters

"CCD"

"PPD"

"WEB"

trace_numbersarray of string

addendastring

optional

pending_amountnumber

Pending amount of the payment in the currency's smallest unit (e.g., cents). The value of this field will go to zero over time once the payment is settled.

resultenum

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

APPROVED payments were successful while DECLINED payments were declined by Lithic or returned.

Hide ParametersShow Parameters

"APPROVED"

"DECLINED"

settled_amountnumber

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

sourceenum

Accepts one of the following: "CUSTOMER", "LITHIC"

Hide ParametersShow Parameters

"CUSTOMER"

"LITHIC"

statusenum

Accepts one of the following: "DECLINED", "PENDING", "RETURNED", "SETTLED"

Status types:

• DECLINED - The payment was declined.
• PENDING - The payment is being processed and has yet to settle or release (origination debit).
• RETURNED - The payment has been returned.
• SETTLED - The payment is completed.

Hide ParametersShow Parameters

"DECLINED"

"PENDING"

"RETURNED"

"SETTLED"

updatedstring

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

formatdate-time

user_defined_idstring

maxLength512

expected_release_datestring

optional

Date when the financial transaction expected to be released after settlement

formatdate