Skip to content
Stainless Stainless Stainless SDKs

List

List external payments
get/v1/external_payments

List external payments

Query Parameters
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: "EXTERNAL_WIRE", "EXTERNAL_ACH", "EXTERNAL_CHECK", "EXTERNAL_TRANSFER"

External Payment category to be returned.

Hide ParametersShow Parameters
"EXTERNAL_WIRE"
"EXTERNAL_ACH"
"EXTERNAL_CHECK"
"EXTERNAL_TRANSFER"
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

Globally unique identifier for the financial account or card that will send the funds. Accepted type dependent on the program's use case.

formatuuid
page_sizenumber
optional

Page size (for pagination).

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

External Payment result to be returned.

Hide ParametersShow Parameters
"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: "PENDING", "SETTLED", "DECLINED", 2 more

Book transfer status to be returned.

Hide ParametersShow Parameters
"PENDING"
"SETTLED"
"DECLINED"
"REVERSED"
"CANCELED"
Returns
dataarray of tokenstringcategoryenumcreatedstringcurrencystringeventsarray of objectfinancial_account_tokenstringpayment_typeenumpending_amountnumberresultenumsettled_amountnumberstatusenumupdatedstringuser_defined_idstringExternalPayment
has_moreboolean
Request example Request
curl https://api.lithic.com/v1/external_payments \
    -H "Authorization: $LITHIC_API_KEY"
200 Example
{
  "data": [
    {
      "token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "category": "EXTERNAL_WIRE",
      "created": "2019-12-27T18:11:19.117Z",
      "currency": "currency",
      "events": [
        {
          "token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "amount": 0,
          "created": "2019-12-27T18:11:19.117Z",
          "detailed_results": [
            "APPROVED"
          ],
          "effective_date": "2019-12-27",
          "memo": "memo",
          "result": "APPROVED",
          "type": "EXTERNAL_WIRE_INITIATED"
        }
      ],
      "financial_account_token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "payment_type": "DEPOSIT",
      "pending_amount": 0,
      "result": "APPROVED",
      "settled_amount": 0,
      "status": "PENDING",
      "updated": "2019-12-27T18:11:19.117Z",
      "user_defined_id": "user_defined_id"
    }
  ],
  "has_more": true
}