List
List payments
get/v1/payments
List all the payments for the provided search criteria.
Query Parameters
account_tokenstring
optional
formatuuid
beginstring
optional
Date string in RFC 3339 format. Only entries created after the specified time will be included. UTC time zone.
formatdate-time
business_account_tokenstring
optional
formatuuid
categoryenum
optional
Accepts one of the following: "ACH"
endstring
optional
Date string in RFC 3339 format. Only entries created before the specified time will be included. UTC time zone.
formatdate-time
ending_beforestring
optional
A cursor representing an item's token before which a page of results should end. Used to retrieve the previous page of results before this item.
financial_account_tokenstring
optional
formatuuid
page_sizenumber
optional
Page size (for pagination).
maximum100
minimum1
resultenum
optional
Accepts one of the following: "APPROVED", "DECLINED"
starting_afterstring
optional
A cursor representing an item's token after which a page of results should begin. Used to retrieve the next page of results after this item.
statusenum
optional
Accepts one of the following: "DECLINED", "PENDING", "RETURNED", "SETTLED"
Returns
dataarray of tokenstringcategoryenumcreatedstringcurrencystringdescriptorstringdirectionenumeventsarray of objectexternal_bank_account_tokenstringfinancial_account_tokenstringmethodenummethod_attributesobjectpending_amountnumberresultenumsettled_amountnumbersourceenumstatusenumupdatedstringuser_defined_idstringexpected_release_datestringPayment
has_moreboolean
More data exists.
Request example Request
curl https://api.lithic.com/v1/payments \
-H "Authorization: $LITHIC_API_KEY"200 Example
{
"data": [
{
"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"
}
],
"has_more": true
}