Lithic API Documentation | External Payments

External Payments

external_payments

Methods

List External Payments -> CursorPage<

ExternalPayment

get/v1/external_payments

List external payments

query Parameters

begin: string

Optional

(format: date-time)

Date string in RFC 3339 format. Only entries created after the specified time will be included. UTC time zone.

business_account_token: string

Optional

(format: uuid)

category:

Optional

External Payment category to be returned.

"EXTERNAL_WIRE"

"EXTERNAL_ACH"

"EXTERNAL_CHECK"

"EXTERNAL_FEDNOW"

"EXTERNAL_RTP"

"EXTERNAL_TRANSFER"

end: string

Optional

(format: date-time)

Date string in RFC 3339 format. Only entries created before the specified time will be included. UTC time zone.

ending_before: string

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_token: string

Optional

(format: uuid)

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

page_size: number

Optional

(maximum: 100, minimum: 1, default: 50)

Page size (for pagination).

result:

Optional

External Payment result to be returned.

"APPROVED"

"DECLINED"

starting_after: string

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.

status:

Optional

Book transfer status to be returned.

"PENDING"

"SETTLED"

"DECLINED"

"REVERSED"

"CANCELED"

"RETURNED"

Response fields

data: Array<

ExternalPayment

has_more: boolean

Request example

curl https://api.lithic.com/v1/external_payments \
    -H "Authorization: $LITHIC_API_KEY"

200Example

{
  "data": [
    {
      "token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "created": "2019-12-27T18:11:19.117Z",
      "status": "PENDING",
      "updated": "2019-12-27T18:11:19.117Z",
      "category": "EXTERNAL_WIRE",
      "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"
        }
      ],
      "family": "EXTERNAL_PAYMENT",
      "financial_account_token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "payment_type": "DEPOSIT",
      "pending_amount": 0,
      "result": "APPROVED",
      "settled_amount": 0,
      "user_defined_id": "user_defined_id"
    }
  ],
  "has_more": true
}