External Payments

List external payments

Changed on

List external payments

get/v1/external_payments

Request

  • Base URL
    https://sandbox.lithic.com
  • URL
    https://sandbox.lithic.com/v1/external_payments
  • Auth
    API key in header Authorization

Query parameters

category'EXTERNAL_WIRE' | 'EXTERNAL_ACH' | 'EXTERNAL_CHECK' | 'EXTERNAL_FEDNOW' | 'EXTERNAL_RTP' | 'EXTERNAL_STABLECOIN' | 'EXTERNAL_TRANSFER'

The external rail the funds moved on

financial_account_tokenstring uuid

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

business_account_tokenstring uuid
result'APPROVED' | 'DECLINED'

External Payment result to be returned.

status'PENDING' | 'SETTLED' | 'DECLINED' | 'REVERSED' | 'CANCELED' | 'RETURNED'

Book transfer status to be returned.

beginstring date-time

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

ending_beforestring

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.

endstring date-time

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

page_sizeinteger

Page size (for pagination).

starting_afterstring

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.

Response

OK

has_moreboolean required

Changes

  • 9798275dc379Revision changes
    • breaking

      the // response's property type changed from object to no type for status

    • breaking

      removed the required property /// from the response with the status

    • breaking

      removed the required property /// from the response with the status

    • breaking

      removed the required property /// from the response with the status

    • breaking

      removed the required property /// from the response with the status

    • info

      added subschema #2 to the // response property allOf list for the response status

  • 9b03f0754e37Revision changes
    • warning

      added the new EXTERNAL_STABLECOIN enum value to the /// response property for the response status

    • warning

      added the new EXTERNAL_STABLECOIN_CANCELED enum value to the ///// response property for the response status

    • warning

      added the new EXTERNAL_STABLECOIN_INITIATED enum value to the ///// response property for the response status

    • warning

      added the new EXTERNAL_STABLECOIN_RELEASED enum value to the ///// response property for the response status

    • warning

      added the new EXTERNAL_STABLECOIN_REVERSED enum value to the ///// response property for the response status

    • warning

      added the new EXTERNAL_STABLECOIN_SETTLED enum value to the ///// response property for the response status

    • info

      added the new enum value EXTERNAL_STABLECOIN to the query request parameter category