class Lithic::Resources::AccountHolders

def list(params = {})

Other tags:
    See: Lithic::Models::AccountHolderListParams -

Returns:
  • (Lithic::Internal::SinglePage) -

Parameters:
  • request_options (Lithic::RequestOptions, Hash{Symbol=>Object}, nil) --
  • starting_after (String) -- A cursor representing an item's token after which a page of results should begin
  • phone_number (String) -- Phone number of the account holder. The query must be an exact match.
  • limit (Integer) -- The number of account_holders to limit the response to.
  • legal_business_name (String) -- (Business Account Holders only) The legal business name of the account holder. T
  • last_name (String) -- (Individual Account Holders only) The last name of the account holder. The query
  • first_name (String) -- (Individual Account Holders only) The first name of the account holder. The quer
  • external_id (String) -- If applicable, represents the external_id associated with the account_holder.
  • ending_before (String) -- A cursor representing an item's token before which a page of results should end.
  • end_ (Time) -- Date string in RFC 3339 format. Only entries created before the specified time w
  • email (String) -- Email address of the account holder. The query must be an exact match, case inse
  • begin_ (Time) -- Date string in RFC 3339 format. Only entries created after the specified time wi

Overloads:
  • list(begin_: nil, email: nil, end_: nil, ending_before: nil, external_id: nil, first_name: nil, last_name: nil, legal_business_name: nil, limit: nil, phone_number: nil, starting_after: nil, request_options: {}) 
def list(params = {})
  parsed, options = Lithic::AccountHolderListParams.dump_request(params)
  @client.request(
    method: :get,
    path: "v1/account_holders",
    query: parsed.transform_keys(begin_: "begin", end_: "end"),
    page: Lithic::Internal::SinglePage,
    model: Lithic::AccountHolder,
    options: options
  )
end