Create
Create payment
post/v1/payments
Initiates a payment between a financial account and an external bank account.
Body Parameters
amountnumber
minimum1
external_bank_account_tokenstring
formatuuid
financial_account_tokenstring
formatuuid
methodenum
Accepts one of the following: "ACH_NEXT_DAY", "ACH_SAME_DAY"
method_attributesobject
typeenum
Accepts one of the following: "COLLECTION", "PAYMENT"
tokenstring
optional
Customer-provided token that will serve as an idempotency token. This token will become the transaction token.
formatuuid
memostring
optional
maxLength512
user_defined_idstring
optional
maxLength512
Returns
balanceavailable_amountnumbercreatedstringcurrencystringfinancial_account_tokenstringfinancial_account_typeenumlast_transaction_event_tokenstringlast_transaction_tokenstringpending_amountnumbertotal_amountnumberupdatedstringBalance
optional
Balance
Request example Request
curl https://api.lithic.com/v1/payments \
-H 'Content-Type: application/json' \
-H "Authorization: $LITHIC_API_KEY" \
-d '{
"amount": 1,
"external_bank_account_token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"financial_account_token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"method": "ACH_NEXT_DAY",
"method_attributes": {
"sec_code": "CCD"
},
"type": "COLLECTION"
}'
200 Example
{
"token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"category": "ACH",
"created": "2019-12-27T18:11:19.117Z",
"currency": "currency",
"descriptor": "descriptor",
"direction": "CREDIT",
"events": [
{
"token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"amount": 0,
"created": "2019-12-27T18:11:19.117Z",
"result": "APPROVED",
"type": "ACH_ORIGINATION_CANCELLED",
"detailed_results": [
"APPROVED"
]
}
],
"external_bank_account_token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"financial_account_token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"method": "ACH_NEXT_DAY",
"method_attributes": {
"company_id": "company_id",
"receipt_routing_number": "receipt_routing_number",
"retries": 0,
"return_reason_code": "return_reason_code",
"sec_code": "CCD",
"trace_numbers": [
"string"
],
"addenda": "addenda"
},
"pending_amount": 0,
"result": "APPROVED",
"settled_amount": 0,
"source": "CUSTOMER",
"status": "DECLINED",
"updated": "2019-12-27T18:11:19.117Z",
"user_defined_id": "user_defined_id",
"expected_release_date": "2019-12-27",
"balance": {
"available_amount": 0,
"created": "2019-12-27T18:11:19.117Z",
"currency": "currency",
"financial_account_token": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"financial_account_type": "ISSUING",
"last_transaction_event_token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"last_transaction_token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"pending_amount": 0,
"total_amount": 0,
"updated": "2019-12-27T18:11:19.117Z"
}
}