Payment

List payments

Changed on

List all the payments for the provided search criteria.

get/v1/payments

Request

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

Query parameters

financial_account_tokenstring uuid
business_account_tokenstring uuid
account_tokenstring uuid
result'APPROVED' | 'DECLINED'
status'DECLINED' | 'PENDING' | 'RETURNED' | 'REVERSED' | 'SETTLED'
category'ACH' | 'STABLECOIN'
beginstring date-time

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

endstring date-time

Date string in RFC 3339 format. Only entries created before 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.

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

More data exists.

Example response

{
  "data": [
    {
      "family": "PAYMENT",
      "status": "PENDING",
      "token": "bd4efddb-771b-49e3-9af9-49b077ab5eb8",
      "created": "2025-10-27T20:12:22Z",
      "updated": "2025-10-27T20:12:25Z",
      "category": "ACH",
      "result": "APPROVED",
      "method_attributes": {
        "sec_code": "CCD",
        "return_reason_code": null,
        "ach_hold_period": 1,
        "retries": 0,
        "company_id": "1111111111",
        "receipt_routing_number": null,
        "recipient_name": null,
        "trace_numbers": [],
        "addenda": null
      },
      "financial_account_token": "35b0c466-a3e3-519a-9549-ead6a6a2277d",
      "external_bank_account_token": "feb4fee1-2414-4c38-a5f6-9deac293c8f4",
      "direction": "CREDIT",
      "source": "LITHIC",
      "method": "ACH_NEXT_DAY",
      "settled_amount": 0,
      "pending_amount": -1588,
      "currency": "USD",
      "events": [
        {
          "amount": -1588,
          "type": "ACH_ORIGINATION_INITIATED",
          "result": "APPROVED",
          "created": "2025-10-27T20:12:22Z",
          "token": "327dccc3-fe42-54d2-962c-7f8135805464",
          "detailed_results": [
            "APPROVED"
          ]
        },
        {
          "amount": -1588,
          "type": "ACH_ORIGINATION_REVIEWED",
          "result": "APPROVED",
          "created": "2025-10-27T20:12:25Z",
          "token": "f9165477-7cfc-53c6-98f1-84e9ec856a60",
          "detailed_results": [
            "APPROVED"
          ]
        }
      ],
      "descriptor": "ach_origination_credit",
      "user_defined_id": null,
      "expected_release_date": null,
      "related_account_tokens": null,
      "type": "ORIGINATION_CREDIT"
    }
  ]
}

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

    • warning

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

    • info

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

    • info

      added 'propertyNames' constraint to the /// response property for the status

  • bb57ad3beaf6Revision changes
    • info

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